Immunization

This topic describes information for the Immunization resource.

To interact with the REST endpoints in the Immunization resource, see Immunization.

Overview

The Immunization resource can include current and historical administration of vaccinations for a patient. The response can include administered immunizations and reported immunizations, including records reconciled from external sources such as the patient, state registries, and Consolidated Clinical Document Architecture (C-CDA) documents. The response does not include immunizations that may be ordered or scheduled but have not been administered yet.

Soarian Clinicals supports a read-only Application Programming Interface (API). This API accepts GET and POST based search and GET based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals at the time of the query.

Note:

The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Error: The common errors and OperationOutcomes may be returned.

The search results include the following fields if they contain values:

• Immunization ID

• Status

• Status reason

• Vaccine administered

• Patient

• Patient encounter

• Occurrence [x]

  • Occurrence date time

  • Occurrence string

• primarySource

Terminology Bindings

• Immunization.statusReason

  Description: The reason why the immunization was not performed.

  Details: Immunization Status Reason

  System: http://terminology.hl7.org/CodeSystem/v3-ActReason

• Immunization.vaccineCode

  Description: The vaccine product administered.

  • Details: CVX

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

  • Details: NDC

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