NAV Navbar
Logo cerner
Ruby Shell

Immunization API v1

The HealtheIntent Immunization API allows systems to interact with immunization data in HealtheIntent.

Note: The data retrieved by this API is filtered based on your sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.

URL: https://cernerdemo.api.us.healtheintent.com/immunization/v1

Immunization

Immunizations are the vaccines that have been administered to a patient. Immunizations data can include information about the administration, documentation about why a vaccine was not given, and patient statements or inferences that the vaccine was administered previously. The API sends all immunizations for a patient that are known in HealtheIntent.

Retrieve a Single Immunization

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/immunization/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/d4c283a6-1a5c-4427-82ce-ef4ef8e35d30/immunizations/922335064680677580716e7c2f791facb99c67ad147fc3fe34b61b1b56ac3fcac762ed2f7f75c80aef3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/immunization/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/d4c283a6-1a5c-4427-82ce-ef4ef8e35d30/immunizations/922335064680677580716e7c2f791facb99c67ad147fc3fe34b61b1b56ac3fcac762ed2f7f75c80aef3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "aliases": [
    {
      "system": "https://fhir.cerner.com/ceuuid",
      "value": "f3105a50-d315-11e9-bb65-2a2ae2dbcce4"
    }
  ],
  "code": {
    "codings": [
      {
        "code": "111",
        "display": "influenza virus vaccine, live, attenuated, for intranasal use",
        "system": "2.16.840.1.113883.12.292"
      },
      {
        "code": "47260",
        "display": "influenza virus vaccine, live",
        "system": "2.16.840.1.113883.6.312"
      },
      {
        "code": "INFLUENZA_VAC",
        "display": "Influenza",
        "system": "640EB34417794175B22A9F9951A81E26"
      }
    ],
    "sourceCodings": [
      {
        "code": "2820756",
        "display": "influenza virus vaccine, live",
        "system": "urn:cerner:coding:codingsystem:codeset:72"
      },
      {
        "code": "47260",
        "display": "influenza virus vaccine, live",
        "system": "2.16.840.1.113883.6.312"
      }
    ],
    "text": "influenza virus vaccine, live"
  },
  "date": "2013-03-21",
  "dose": {
    "unit": {
      "codings": [
        {
          "code": "258773002",
          "display": "mL",
          "system": "2.16.840.1.113883.6.96"
        }
      ],
      "sourceCodings": [
        {
          "code": "293",
          "display": "mL",
          "system": "urn:cerner:coding:codingsystem:codeset:54"
        }
      ],
      "text": "mL"
    },
    "value": "0.5"
  },
  "encounter": {
    "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
  },
  "given": true,
  "id": "e6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d56",
  "lot": "M67951",
  "manufacturer": {
    "codings": [
      {
        "code": "PFR",
        "display": "Pfizer, Inc",
        "system": "2.16.840.1.114222.4.11.826"
      }
    ],
    "sourceCodings": [
      {
        "code": "3630277",
        "display": "JDB Healthcare",
        "system": "urn:cerner:coding:codingsystem:codeset:221"
      }
    ],
    "text": "JDB Healthcare"
  },
  "notes": [
    {
      "author": {
        "aliases": [
          {
            "system": "2.16.840.1.113883.4.814",
            "type": "DEA",
            "value": "1234"
          }
        ],
        "date": "2018-01-23",
        "name": {
          "formatted": "Brizendine, Margaret"
        }
      },
      "text": "Patient is feeling well today."
    }
  ],
  "performers": [
    {
      "function": {
        "codings": [
          {
            "code": "OP",
            "display": "Ordering Provider",
            "system": "2.16.840.1.113883.12.443"
          }
        ],
        "sourceCodings": [
          {
            "code": "OP",
            "display": "Ordering Provider",
            "system": "2.16.840.1.113883.12.443"
          }
        ],
        "text": "Ordering Provider"
      },
      "provider": {
        "aliases": [
          {
            "system": "2.16.840.1.113883.4.814",
            "type": "DEA",
            "value": "1234"
          }
        ],
        "name": {
          "prefix": "Dr.",
          "given": [
            "Jane",
            "Susannah"
          ],
          "family": [
            "Smith"
          ],
          "suffix": "MD",
          "formatted": "Dr. Jane Susannah Smith MD"
        }
      }
    }
  ],
  "primarySource": true,
  "provenances": [
    {
      "entities": [
        {
          "role": {
            "sourceCodings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "codings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "text": "Source"
          },
          "what": {
            "documentReference": {
              "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
            }
          }
        }
      ],
      "agents": [
        {
          "type": {
            "sourceCodings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "codings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "text": "Author"
          },
          "who": {
            "organization": {
              "name": "Rockcreek Clinic",
              "aliases": [
                {
                  "value": "151579",
                  "type": "EXTERNAL",
                  "system": "1.2.3.4.5.6.7.8.9.10.1"
                }
              ]
            }
          }
        }
      ],
      "recordedOn": "2011-07-26T23:53:00.000Z"
    }
  ],
  "reasonNotGiven": {
    "codings": [
      {}
    ],
    "sourceCodings": [
      {}
    ]
  },
  "route": {
    "codings": [
      {
        "code": "78421000",
        "display": "Intramuscular route",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "78421000",
        "display": "Intramuscular route",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Intramuscular route"
  },
  "sourceIdentifier": {
    "dataPartitionId": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
    "id": "12345"
  },
  "status": {
    "codings": [
      {
        "code": "255594003",
        "display": "Complete (qualifier value)",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "255594003",
        "display": "Complete (qualifier value)",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Complete (qualifier value)"
  }
}

GET /populations/{populationId}/patients/{patientId}/immunizations/{immunizationId}

Retrieves a single immunization for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The identifier of the patient. -
populationId path string true N/A The identifier of the population. -
immunizationId path string true N/A The ID that uniquely identifies the immunization for the patient. -

Response Statuses

Status Meaning Description Schema
200 OK OK Immunization
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Retrieve a List of Immunizations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/immunization/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/d4c283a6-1a5c-4427-82ce-ef4ef8e35d30/immunizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/immunization/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/d4c283a6-1a5c-4427-82ce-ef4ef8e35d30/immunizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "aliases": [
        {
          "system": "https://fhir.cerner.com/ceuuid",
          "value": "f3105a50-d315-11e9-bb65-2a2ae2dbcce4"
        }
      ],
      "code": {
        "codings": [
          {
            "code": "111",
            "display": "influenza virus vaccine, live, attenuated, for intranasal use",
            "system": "2.16.840.1.113883.12.292"
          },
          {
            "code": "47260",
            "display": "influenza virus vaccine, live",
            "system": "2.16.840.1.113883.6.312"
          },
          {
            "code": "INFLUENZA_VAC",
            "display": "Influenza",
            "system": "640EB34417794175B22A9F9951A81E26"
          }
        ],
        "sourceCodings": [
          {
            "code": "2820756",
            "display": "influenza virus vaccine, live",
            "system": "urn:cerner:coding:codingsystem:codeset:72"
          },
          {
            "code": "47260",
            "display": "influenza virus vaccine, live",
            "system": "2.16.840.1.113883.6.312"
          }
        ],
        "text": "influenza virus vaccine, live"
      },
      "date": "2013-03-21",
      "dose": {
        "unit": {
          "codings": [
            {
              "code": "258773002",
              "display": "mL",
              "system": "2.16.840.1.113883.6.96"
            }
          ],
          "sourceCodings": [
            {
              "code": "293",
              "display": "mL",
              "system": "urn:cerner:coding:codingsystem:codeset:54"
            }
          ],
          "text": "mL"
        },
        "value": "0.5"
      },
      "encounter": {
        "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
      },
      "given": true,
      "id": "e6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d56",
      "lot": "M67951",
      "manufacturer": {
        "codings": [
          {
            "code": "PFR",
            "display": "Pfizer, Inc",
            "system": "2.16.840.1.114222.4.11.826"
          }
        ],
        "sourceCodings": [
          {
            "code": "3630277",
            "display": "JDB Healthcare",
            "system": "urn:cerner:coding:codingsystem:codeset:221"
          }
        ],
        "text": "JDB Healthcare"
      },
      "notes": [
        {
          "author": {
            "aliases": [
              {
                "system": "2.16.840.1.113883.4.814",
                "type": "DEA",
                "value": "1234"
              }
            ],
            "date": "2018-01-23",
            "name": {
              "formatted": "Brizendine, Margaret"
            }
          },
          "text": "Patient is feeling well today."
        }
      ],
      "performers": [
        {
          "function": {
            "codings": [
              {
                "code": "OP",
                "display": "Ordering Provider",
                "system": "2.16.840.1.113883.12.443"
              }
            ],
            "sourceCodings": [
              {
                "code": "OP",
                "display": "Ordering Provider",
                "system": "2.16.840.1.113883.12.443"
              }
            ],
            "text": "Ordering Provider"
          },
          "provider": {
            "aliases": [
              {
                "system": "2.16.840.1.113883.4.814",
                "type": "DEA",
                "value": "1234"
              }
            ],
            "name": {
              "prefix": "Dr.",
              "given": [
                "Jane",
                "Susannah"
              ],
              "family": [
                "Smith"
              ],
              "suffix": "MD",
              "formatted": "Dr. Jane Susannah Smith MD"
            }
          }
        }
      ],
      "primarySource": true,
      "provenances": [
        {
          "entities": [
            {
              "role": {
                "sourceCodings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "codings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "text": "Source"
              },
              "what": {
                "documentReference": {
                  "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
                }
              }
            }
          ],
          "agents": [
            {
              "type": {
                "sourceCodings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "codings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "text": "Author"
              },
              "who": {
                "organization": {
                  "name": "Rockcreek Clinic",
                  "aliases": [
                    {
                      "value": "151579",
                      "type": "EXTERNAL",
                      "system": "1.2.3.4.5.6.7.8.9.10.1"
                    }
                  ]
                }
              }
            }
          ],
          "recordedOn": "2011-07-26T23:53:00.000Z"
        }
      ],
      "reasonNotGiven": {
        "codings": [
          {}
        ],
        "sourceCodings": [
          {}
        ]
      },
      "route": {
        "codings": [
          {
            "code": "78421000",
            "display": "Intramuscular route",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "78421000",
            "display": "Intramuscular route",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Intramuscular route"
      },
      "sourceIdentifier": {
        "dataPartitionId": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
        "id": "12345"
      },
      "status": {
        "codings": [
          {
            "code": "255594003",
            "display": "Complete (qualifier value)",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "255594003",
            "display": "Complete (qualifier value)",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Complete (qualifier value)"
      }
    }
  ],
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/immunization/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/37bad71c-9276-4f55-b54d-f0491f2bb777/immunizations?limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/immunization/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/37bad71c-9276-4f55-b54d-f0491f2bb777/immunizations?cursor=e6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d56&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/immunizations

Retrieves a list of the immunizations for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The identifier of the patient. -
populationId path string true N/A The identifier of the population. -
cursor query string false N/A The last item on the list in the response from the previous request. If you specify this parameter, the response begins with the next item on the list. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK Immunizations
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Schema Definitions

Immunization

Name Type Required Description Accepted Values
aliases [Alias] true A list of unique identifiers to identify an immunization within a given system. -
code CodeableConcept false The vaccine or product that was or was not given to the patient. For example, the immunization can be described by a CVX (CDC vaccines administered), CPT, RxNorm, National Drug Code (NDC), or Multum code or a HealtheIntent ontological concept. -
date string false The date and time the immunization was administered, or the date and time the immunization was planned to be administered but was not given (for example, if it was refused or contraindicated). In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
dose Dose false The quantity of the administered immunization dose. -
encounter Encounter false The encounter associated with the immunization. -
given boolean true Indicates whether the vaccine was administered. -
id string true The unique ID of the immunization record. -
lot string false The lot number of the drug or vaccine administered. -
manufacturer CodeableConcept false The organization that was responsible for making or producing the vaccine. For example, the manufacturer can be represented by a MVX code. -
notes [ProviderNote] true The notes or comments associated with the immunization. -
performers [Performer] false The providers who ordered or administered the immunization. -
primarySource boolean false Boolean value to indicate that the content of the record is based on information from the person who administered the vaccine. -
provenances [Provenance] true The record-keeping assertions about the context in which the information in this immunization was obtained (for example, the authoring organization, the transmitter or custodian organization that informs the chain of custody, or the source Consolidated Clinical Document Architecture (C-CDA) document from which this immunization was derived, if applicable). -
reasonNotGiven CodeableConcept false Indicates the reason the immunization was not given, for example, contraindicated or refused. -
route CodeableConcept false How the vaccine entered the body, for example, oral or intramuscular. -
sourceIdentifier SourceIdentifier false An ID that uniquely identifies this immunization for a patient in a data partition. -
status CodeableConcept false The state of the immunization record, such as completed or entered in error. -

Alias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values may be unique in each system but not across systems. -
value string false The ID issued by the assigning authority. The formatting may vary by alias type. -

CodeableConcept

Name Type Required Description Accepted Values
codings [Code] true A list of codified values from standard code systems recognized by HealtheIntent. -
sourceCodings [Code] true The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. -
text string false This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

Dose

Name Type Required Description Accepted Values
unit CodeableConcept false The unit of measure associated with the dose quantity, such as mg. -
value string false The quantity or amount of the vaccine that was administered. -

Encounter

Name Type Required Description Accepted Values
id string false The unique ID of the encounter. -

ProviderNote

Name Type Required Description Accepted Values
date string false The date when the note was recorded. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
text string true The textual content of the note or comment. -
author Provider false The individual who recorded the note or comment. -
type CodeableConcept false The type of the note or comment. -

Provider

Name Type Required Description Accepted Values
aliases [ProviderAlias] false A list of IDs of the provider, such as the ten-digit National Provider Identifier (NPI) or the Drug Enforcement Administration (DEA) number. -
name ProviderName false The attributes of the provider name. -

ProviderAlias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -
type string true The type of alias. DEA, EXTERNAL, NPI, SL, TAX, UPIN

ProviderName

Name Type Required Description Accepted Values
prefix string false The parts that come before the name such as Dr., Mr., or Mrs. -
given [string] true A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list. -
family [string] true A list of family (last) name portions of the person’s name. Some people have multiple family names. -
suffix string false The parts that come after the name such as MD, III, or Jr. -
formatted string false The person’s fully-formatted name. -

Performer

Name Type Required Description Accepted Values
function CodeableConcept false A code representation of the type of performer (for example, ordering provider, administering provider, and so on). -
provider Provider false The provider who ordered or administered the immunization. -

Provenance

Name Type Required Description Accepted Values
entities [ProvenanceEntity] true A list of entities used in this activity. -
agents [ProvenanceAgent] true Actors taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. -
recordedOn string false When the activity was recorded/updated. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

ProvenanceEntity

Name Type Required Description Accepted Values
role CodeableConcept false How the entity was used in a provenance activity (for example, source). -
what ProvenanceEntityIdentity false Identity of the entity used in the provenance activity. -

ProvenanceEntityIdentity

Name Type Required Description Accepted Values
documentReference DocumentReferenceId false The ID of the document reference entity used in the provenance activity. -

DocumentReferenceId

Name Type Required Description Accepted Values
id string false The unique ID that identifies the document reference within the data partition to which it was published. -

ProvenanceAgent

Name Type Required Description Accepted Values
type CodeableConcept true The participation the agent had with respect to the activity. -
who ProvenanceAgentEntity false Who participated as an agent in a provenance activity. -

ProvenanceAgentEntity

Name Type Required Description Accepted Values
organization Organization false An organization participating entity. -

Organization

Name Type Required Description Accepted Values
name string false The name of the organization. -
aliases [OrganizationAlias] true A list of IDs of the organization, such as the NPI or the tax ID. -

OrganizationAlias

Name Type Required Description Accepted Values
value string true The unique ID of the alias. -
type string true The type of organization alias, such as NPI. NPI, TAX, EXTERNAL, NABP, HL7_OID
system string false The authority responsible for assigning the alias value. Alias values may be unique within this system namespace but not across systems. -

SourceIdentifier

Name Type Required Description Accepted Values
dataPartitionId string false The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. -
id string false An ID that uniquely identifies this entity for a patient in the data partition. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

Immunizations

Name Type Required Description Accepted Values
items [Immunization] true [Retrieves a single immunization for a given patient.] -
firstLink string true The first page of results. -
nextLink string false The next page of results. -