Immunization REST Endpoints

Sort by

Task Path Method

Description

Immunization

This topic describes information for the Immunization resource.

Overview

The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines, in all care settings, and all regions. This resource contains the functionality to query a patient's immunization history. Detailed administration records may be found in the MedicationAdministration resource, while this Immunization resource would represent the known vaccination history regardless of where the administration itself was done.

An immunization reaction may indicate an allergy or intolerance. If so, a separate AllergyIntolerance resource instance must be created.

Note that while the terms immunization and vaccination are not clinically identical, for the purposes of FHIR resources, the terms are used synonymously.

The following fields are returned if valued:

• ID

• Vaccine administered

• Administration date/time

• Status

• Patient

• Was not given

• Reason not given

• Patient encounter

• Who administered

• Administration site

• Administration route

• Vaccine manufacturer

• Lot number

• Expiration date

• Dose

Terminology Bindings

• Immunization.vaccineCode

  Description: Identifies the vaccine substance administered.

  Note:

  The CVX binding is always returned. A NDC binding is returned when available.

  • Details: CVX

    System: http://hl7.org/fhir/sid/cvx

  • Details: NDC

    System: http://hl7.org/fhir/sid/ndc

• Immunization.site

  Description: The site at which the vaccine was administered.

  Details: SNOMED CT

  System: http://snomed.info/sct

• Immunization.route

  Description: The path the administered medication takes to get into the body or into contact with the body.

  • Details: SNOMED CT

    System: http://snomed.info/sct

  • Details: NCI Metathesaurus

    System: http://ncimeta.nci.nih.gov

• Immunization.explanation.reasonNotGiven

  Description: The reason why a vaccine was not administered.

  Details: v3 Code System ActReason

  System: http://hl7.org/fhir/v3/ActReason

Immunization

The operations from the Immunization category.

Get a list of immunizations

Method: get

Path: /Immunization

Get an immunization by ID

Method: get

Path: /Immunization/{ID}