CodeSystem Resource

GET /terminology/v1/fhir/r4/CodeSystem/

The CodeSystem Resource describes available code systems and the codes they contain.

Contents

Using CodeSystems
Getting a List of Available CodeSystems
Getting All Codes in a CodeSystem

Using CodeSystems

Within a code system an individual code has a distinct meaning; the same code may mean different things in other code systems.

Many standard code systems such as ICD-10-CM, HCPCS, NDC, LOINC and others are available in their most recent revision via the Terminology API.

Please see the FHIR documentation for the complete specification of the CodeSystem Resource. Some common operations are summarized below.

Getting a List of Available CodeSystems

The Terminology API supports search operations on the CodeSystem resource. The following request will retrieve a Bundle of CodeSystem Resources available on the server.

Tip
When searching CodeSystems the _summary=true flag is required.

GET https://api.careevolutionapi.com/terminology/v1/fhir/r4/CodeSystem/?_summary=true

Each available [CODE_SYSTEM_ID] can be found in Bundle.CodeSystem.entry.resource.id.

Sample Response

{
    "resourceType": "Bundle",
    "id": "d5c6163b-8f5b-4e2a-86e3-084e3b5853ab",
    "type": "searchset",
    "total": 112,
    "entry": [
       {
            "fullUrl": "https://api.careevolutionapi.com/terminology/v1/fhir/r4/CodeSystem/RxNorm",
            "resource": {
                "resourceType": "CodeSystem",
                "id": "RxNorm",
                "url": "http://www.nlm.nih.gov/research/umls/rxnorm",
                "identifier": {
                    "system": "urn:ietf:rfc:3986",
                    "value": "urn:oid:2.16.840.1.113883.6.88"
                },
                "version": "210503.0.0",
                "name": "RxNorm",
                "content": "not-present",
                "count": 220858
            }
        },
        {
            "fullUrl": "https://api.careevolutionapi.com/terminology/v1/fhir/r4/CodeSystem/NDC",
            "resource": {
                "resourceType": "CodeSystem",
                "id": "NDC",
                "url": "http://hl7.org/fhir/sid/ndc",
                "identifier": {
                    "system": "urn:ietf:rfc:3986",
                    "value": "urn:oid:2.16.840.1.113883.6.69"
                },
                "version": "TDEwxpl/okJEyCz2eWDAgmKE7eFIJaDZEcwwcItY/ss=",
                "name": "NDC",
                "content": "not-present",
                "count": 516785
            }
        },
        ...
    ]
}

Getting All Codes in a CodeSystem

With a [CODE SYSTEM ID], retrieving codes from a CodeSystem can be done with a simple GET operation.

GET https://api.careevolutionapi.com/terminology/v1/fhir/r4/CodeSystem/[CODE_SYSTEM_ID]

For example the following will get a list of all ICD-10-CM codings as a complete CodeSystem Resource:

GET https://api.careevolutionapi.com/terminology/v1/fhir/r4/CodeSystem/ICD-10-CM

Sample Response

{
    "resourceType": "CodeSystem",
    "id": "ICD-10-CM",
    "url": "http://hl7.org/fhir/sid/icd-10-cm",
    "identifier": {
        "system": "urn:ietf:rfc:3986",
        "value": "urn:oid:2.16.840.1.113883.6.90"
    },
    "version": "2021.1.0",
    "name": "ICD-10-CM",
    "content": "complete",
    "count": 95687,
    "concept": [
        {
            "code": "A00",
            "display": "Cholera"
        },
        {
            "code": "A00.0",
            "display": "Cholera due to Vibrio cholerae 01, biovar cholerae"
        },
        ...
    ]
}