/public/
will search published entities only and require no authentication.?format=json
or ?format=xml
to specify the required API output format.
concept-library-R-client
Swagger UI
Swagger json
Swagger yaml
Lists the published concepts.
get /api/v1/public/concepts/
User can search with criteria using a combinations of querystring parameters:
?search=Alcohol
?collection_ids=20,23
/api/v1/public/collections/
)
?tag_ids=1,3
/api/v1/public/tags/
)
?coding_ids=4
?data_source_ids=1
?start_date=2018-01-01&end_date=2022-08-25
?show_only_validated_concepts=1
?brand=HDRUK
?author=Kuan
?do_not_show_versions=1
Example: /api/v1/public/concepts/?author=m&brand=adp&tag_collection_ids=11
)
Lists a published concepts by id.
get /api/v1/public/concepts/{id}/
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/
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/
Lists the published versions of the published concept .
get /api/v1/public/concepts/{id}/get-versions/
Authenticated APIs return both public content and content that has not yet been published. A user account is required.
Lists all available concepts for the user.
get /api/v1/concepts/
User can search with criteria using a combinations of querystring parameters:
?search=Alcohol
?collection_ids=20,23
/api/v1/public/collections/
)
?tag_ids=1,3
/api/v1/public/tags/
)
?coding_ids=4
?data_source_ids=1
?start_date=2018-01-01&end_date=2022-08-25
?show_only_my_concepts=1
?show_deleted_concepts=1
?show_only_validated_concepts=1
?brand=HDRUK
?author=Kuan
?owner_username=a.john
?do_not_show_versions=1
?must_have_published_versions=1
Example: /api/v1/concepts/?author=m&brand=adp&tag_collection_ids=11
)
Lists a concept by id for the user.
get /api/v1/concepts/{id}/
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/
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/
Lists all the versions of the concept for the user.
get /api/v1/concepts/{id}/get-versions/
Lists the published phenotypes and the data sources associated with each.
get /api/v1/public/phenotypes/
User can search with criteria using a combinations of querystring parameters:
?search=Alcohol
?collection_ids=20,23
/api/v1/public/collections/
)
?tag_ids=1,3
/api/v1/public/tags/
)
?selected_phenotype_types=drug,lifestyle risk factor
reference data page
?coding_ids=4
?data_source_ids=1
?start_date=2018-01-01&end_date=2022-08-25
?show_only_validated_phenotypes=1
?brand=HDRUK
?author=Kuan
?do_not_show_versions=1
Example: /api/v1/public/phenotypes/?author=m&brand=adp&tag_collection_ids=11
)
Lists a published phenotypes by id and the data sources associated with it.
get /api/v1/public/phenotypes/{id}/
Lists the pubished phenotype detail of the latest published version.
get /api/v1/public/phenotypes/{id}/detail/
Lists the published phenotype detail of the specified published version.
get /api/v1/public/phenotypes/{id}/version/{version_id}/detail/
Exports the code list of the latest version of a published phenotype.
get /api/v1/public/phenotypes/{id}/export/codes/
Exports the code list of a specific version of a published phenotype.
get /api/v1/public/phenotypes/{id}/version/{version_id}/export/codes/
Lists the published versions of the published phenotype .
get /api/v1/public/phenotypes/{id}/get-versions/
Authenticated APIs return both public content and content that has not yet been published. A user account is required.
Lists all available phenotypes for the user and the data sources associated with each.
get /api/v1/phenotypes/
User can search with criteria using a combinations of querystring parameters:
?search=Alcohol
?collection_ids=20,23
/api/v1/public/collections/
)
?tag_ids=1,3
/api/v1/public/tags/
)
?coding_ids=4
?data_source_ids=1
?start_date=2018-01-01&end_date=2022-08-25
?selected_phenotype_types=drug,lifestyle risk factor
reference data page
?show_only_my_phenotypes=1
?show_deleted_phenotypes=1
?show_only_validated_phenotypes=1
?brand=HDRUK
?author=Kuan
?owner_username=a.john
?do_not_show_versions=1
?must_have_published_versions=1
Example: /api/v1/phenotypes/?author=m&brand=adp&tag_collection_ids=11
)
Lists a phenotype by id for the user and the data sources associated with it.
get /api/v1/phenotypes/{id}/
Lists the phenotype detail of the latest version.
get /api/v1/phenotypes/{id}/detail/
Lists the phenotype detail of the specified version.
get /api/v1/phenotypes/{id}/version/{version_id}/detail/
Exports the code list of the latest version of a phenotype for the user.
get /api/v1/phenotypes/{id}/export/codes/
Exports the code list of a specific version of a phenotype for the user.
get /api/v1/phenotypes/{id}/version/{version_id}/export/codes/
Lists all the versions of the phenotype for the user.
get /api/v1/phenotypes/{id}/get-versions/
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}
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 return both public content and content that has not yet been published. A user account is required.
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}
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}
Lists all available collections.
get /api/v1/public/collections/
User can search with part of the collection name using querystring parameter:
?search=breathe
Example: /api/v1/public/collections/?search=breathe
)
Lists collection by id.
get /api/v1/public/collections/{id}