API

Concepts:

1. List/Search concepts

Lists the published concepts.

get /api/v1/public/concepts/

User can search with criteria using a combinations of querystring parameters:


• ?search=Alcohol
  search by part of concept name (do not put wild characters here)
• ?collection_ids=20,23
  You can specify collection ids
  (get collections from /api/v1/public/collections/)
• ?tag_ids=1,3
  You can specify tag ids
  (get tags from /api/v1/public/tags/)
• ?coding_ids=4
  Specify the coding system of the phenotype
• ?data_source_ids=1
  Specify the data source of the phenotype
• ?start_date=2018-01-01&end_date=2022-08-25
  Specify the date range of your query
• ?show_only_validated_concepts=1
  will show only validated concepts
• ?brand=HDRUK
  will show only concepts with brand=HDRUK
• ?author=Kuan
  search by part of the author name
• ?do_not_show_versions=1
  do not show concepts versions (by default, all concept's version ids are shown)

(Example: /api/v1/public/concepts/?author=m&brand=adp&tag_collection_ids=11)

2. List concept by id

Lists a published concepts by id.

get /api/v1/public/concepts/{id}/

3. List concept detail

Lists the pubished concept detail of the latest published version.

get /api/v1/public/concepts/{id}/detail/

Lists the published concept detail of the specified published version.

get /api/v1/public/concepts/{id}/version/{version_id}/detail/

4. Export the code list of a concept

Exports the code list of the latest version of a published concept.

get /api/v1/public/concepts/{id}/export/codes/

Exports the code list of a specific version of a published concept.

get /api/v1/public/concepts/{id}/version/{version_id}/export/codes/

5. List the versions of a concept

Lists the published versions of the published concept .

get /api/v1/public/concepts/{id}/get-versions/

Authenticated APIs:

1. List/Search concepts

Lists all available concepts for the user.

get /api/v1/concepts/

User can search with criteria using a combinations of querystring parameters:


• ?search=Alcohol
  search by part of concept name (do not put wild characters here)
• ?collection_ids=20,23
  You can specify collection ids
  (get collections from /api/v1/public/collections/)
• ?tag_ids=1,3
  You can specify tag ids
  (get tags from /api/v1/public/tags/)
• ?coding_ids=4
  Specify the coding system of the phenotype
• ?data_source_ids=1
  Specify the data source of the phenotype
• ?start_date=2018-01-01&end_date=2022-08-25
  Specify the date range of your query
• ?show_only_my_concepts=1
  Only show concepts owned by me
• ?show_deleted_concepts=1
  will show also deleted concepts (by default, deleted objects are not shown)
• ?show_only_validated_concepts=1
  will show only validated concepts
• ?brand=HDRUK
  will show only concepts with brand=HDRUK
• ?author=Kuan
  search by part of the author name
• ?owner_username=a.john
  search by full username of the owner
• ?do_not_show_versions=1
  do not show concepts versions (by default, all concept's version ids are shown)
• ?must_have_published_versions=1
  show only concepts which have a published version(by default, all concepts are shown)

(Example: /api/v1/concepts/?author=m&brand=adp&tag_collection_ids=11)

2. List concept by id

Lists a concept by id for the user.

get /api/v1/concepts/{id}/

3. List concept detail

Lists the concept detail of the latest version.

get /api/v1/concepts/{id}/detail/

Lists the concept detail of the specified version.

get /api/v1/concepts/{id}/version/{version_id}/detail/

4. Export the code list of a concept

Exports the code list of the latest version of a concept for the user.

get /api/v1/concepts/{id}/export/codes/

Exports the code list of a specific version of a concept for the user.

get /api/v1/concepts/{id}/version/{version_id}/export/codes/

5. List the versions of a concept

Lists all the versions of the concept for the user.

get /api/v1/concepts/{id}/get-versions/

Data Sources:

1. List data sources

Lists all data sources available. User can search by part of the data source name (e.g. ?search=hospital)

get /api/v1/public/data-sources-list/

Lists a data source by id.

get /api/v1/public/data-sources-list/{id}

2. List data sources (with published phenotypes)

Only the published associated phenotypes wil be shown.

Lists all data sources and the published phenotypes associated with each. User can search by part of the data source name (e.g. ?search=hospital)

get /api/v1/public/data-sources/

Lists a data source by id and the associated published phenotypes.

get /api/v1/public/data-sources/{id}

Authenticated APIs:

1. List data sources

Lists all data sources and the phenotypes associated with each. User can search by part of the data source name (e.g. ?search=hospital)

get /api/v1/data-sources/

Lists a data source by id and the associated phenotypes.

get /api/v1/data-sources/{id}

coding systems:

1. List coding systems

Lists all coding systems available. User can search by part of the coding system name (e.g. ?search=read)

get /api/v1/public/coding-systems/

Lists a coding system by id.

get /api/v1/public/coding-systems/{id}

Tags:

1. List tags

Lists all available tags.

get /api/v1/public/tags/

User can search with part of the tag name using querystring parameter:


• ?search=TECC
  search by part of tag name (do not put wild characters here)

(Example: /api/v1/public/tags/?search=breathe)

Lists tag by id.

get /api/v1/public/tags/{id}

Collections:

1. List collections

Lists all available collections.

get /api/v1/public/collections/

User can search with part of the collection name using querystring parameter:


• ?search=breathe
  search by part of collection name (do not put wild characters here)

(Example: /api/v1/public/collections/?search=breathe)

Lists collection by id.

get /api/v1/public/collections/{id}