Immunization

• Overview
• Terminology Bindings
• Search
  • Authorization Types
  • Parameters
  • Headers
  • Example Search by Patient
  • Example Search by ID
  • Errors
• Retrieve by ID
  • Authorization Types
  • Headers
  • Example
  • Errors
  • Patient Authorization Request for Completed Status
  • Errors
  • Patient Authorization Request for Entered in Error Status
  • Errors
  • Patient Authorization Request for Not Done Status
  • Errors

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.

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

• Immunization id
• Status
• Status reason
• Vaccine administered
• Patient
• Occurrence[x]
  • Occurrence date time
  • Occurrence string
• primarySource

Terminology Bindings

Immunization.statusReason

Description Reason the immunization was not performed. Details: Immunization Status Reason System: https://terminology.hl7.org/CodeSystem/v3-ActReason

Immunization.vaccineCode

Description Vaccine product administered. Note The CVX binding is always returned. An NDC binding is returned when available. Details: CVX System: https://hl7.org/fhir/sid/cvx Details: NDC System: https://hl7.org/fhir/sid/ndc

Search

Search for Immunization resources that meet the specified query parameters:

GET /Immunization?:parameters

Authorization Types

Parameters

Name	Required?	Type	Description
_id	This, or patient	token	The logical resource ID associated with the resource.
patient	This, or _id	reference	The patient for the vaccination record.
_revinclude	No	_revinclude	A request to include any Provenance resource in the bundle that refers to a Immunization resource in the search results. Only supported with Provenance.

Notes:

• The _revinclude parameter may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target
• When _revinclude is provided in a request, the OAuth2 token must include the patient/Provenance.read system/Provenance.read or user/Provenance.read scope as applicable.

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example Search by Patient

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization?patient=4C05F5F357EE44FC874C0CF4AB249F99

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "339048c4-9ff8-4ecb-9260-0136bb3828dd",
  "type": "searchset",
  "timestamp": "2022-05-11T06:04:34-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000083001",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000083001",
        "meta": {
          "lastUpdated": "2021-05-24T17:13:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "83",
              "display": "HEPATITIS A VIRUS VACCINE/PF"
            },
            {
              "system": "http://hl7.org/fhir/sid/ndc",
              "code": "58160-0825-43",
              "display": "HEPATITIS A VIRUS VACCINE/PF"
            }
          ],
          "text": "HEPATITIS A VIRUS VACCINE/PF"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2021-05-24T17:13:00-04:00",
        "primarySource": true,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:83 <b>Display</b>:HEPATITIS A VIRUS VACCINE/PF ;<br /><b>System</b>:http://hl7.org/fhir/sid/ndc <b>Code</b>:58160-0825-43 <b>Display</b>:HEPATITIS A VIRUS VACCINE/PF ;<br /><b>Occurrence</b>:2021-05-24T17:13:00-04:00;<br /><b>Primary Source</b>:true;<br /></div>"
        }
      }
    },
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000110001",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000110001",
        "meta": {
          "lastUpdated": "2021-05-24T17:01:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "110",
              "display": "HEP B VACCINE/DP(A)T-POLIO/PF"
            },
            {
              "system": "http://hl7.org/fhir/sid/ndc",
              "code": "58160-0811-43",
              "display": "HEP B VACCINE/DP(A)T-POLIO/PF"
            }
          ],
          "text": "HEP B VACCINE/DP(A)T-POLIO/PF"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2021-05-24T17:01:00-04:00",
        "primarySource": true,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:110 <b>Display</b>:HEP B VACCINE/DP(A)T-POLIO/PF ;<br /><b>System</b>:http://hl7.org/fhir/sid/ndc <b>Code</b>:58160-0811-43 <b>Display</b>:HEP B VACCINE/DP(A)T-POLIO/PF ;<br /><b>Occurrence</b>:2021-05-24T17:01:00-04:00;<br /><b>Primary Source</b>:true;<br /></div>"
        }
      }
    },
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107002",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107002",
        "meta": {
          "lastUpdated": "2021-05-24T16:58:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "107",
              "display": "DTaP, NOS"
            }
          ],
          "text": "DTaP, NOS"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2011-12-14",
        "primarySource": false,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:107 <b>Display</b>:DTaP, NOS ;<br /><b>Occurrence</b>:2011-12-14;<br /><b>Primary Source</b>:false;<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization?patient=4C05F5F357EE44FC874C0CF4AB249F99&_format=json"
    }
  ]
}

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.

Example Search by ID

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization?_id=4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001&patient=4C05F5F357EE44FC874C0CF4AB249F99

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "d0624076-0e98-4bad-953e-2bfc5328e591",
  "type": "searchset",
  "timestamp": "2022-05-11T06:09:06-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "Immunization",
        "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001",
        "meta": {
          "lastUpdated": "2021-05-24T16:56:00-04:00"
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "107",
              "display": "DTaP, NOS"
            }
          ],
          "text": "DTaP, NOS"
        },
        "patient": {
          "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
          "display": "Lancelot,Kaycee Mason"
        },
        "occurrenceDateTime": "2011-10",
        "primarySource": false,
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:107 <b>Display</b>:DTaP, NOS ;<br /><b>Occurrence</b>:2011-10;<br /><b>Primary Source</b>:false;<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization?_id=4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001&patient=4C05F5F357EE44FC874C0CF4AB249F99&_format=json"
    }
  ]
}

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.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by ID

List an individual Immunization resource by its ID:

GET /Immunization/:id

Authorization Types

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001

Response

Status: 200 OK

{
  "resourceType": "Immunization",
  "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001",
  "meta": {
    "lastUpdated": "2021-05-24T16:56:00-04:00"
  },
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "107",
        "display": "DTaP, NOS"
      }
    ],
    "text": "DTaP, NOS"
  },
  "patient": {
    "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
    "display": "Lancelot,Kaycee Mason"
  },
  "occurrenceDateTime": "2011-10",
  "primarySource": false,
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:107 <b>Display</b>:DTaP, NOS ;<br /><b>Occurrence</b>:2011-10;<br /><b>Primary Source</b>:false;<br /></div>"
  }
}

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.

Errors

The common errors and OperationOutcomes may be returned.

Patient Authorization Request for Completed Status

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001

Response

Status: 200 OK

{
  "resourceType": "Immunization",
  "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000107001",
  "meta": {
    "lastUpdated": "2021-05-24T16:56:00-04:00"
  },
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "107",
        "display": "DTaP, NOS"
      }
    ],
    "text": "DTaP, NOS"
  },
  "patient": {
    "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
    "display": "Lancelot,Kaycee Mason"
  },
  "occurrenceDateTime": "2011-10",
  "primarySource": false,
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:completed;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:107 <b>Display</b>:DTaP, NOS ;<br /><b>Occurrence</b>:2011-10;<br /><b>Primary Source</b>:false;<br /></div>"
  }
}

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.

Errors

The common errors and OperationOutcomes may be returned.

Patient Authorization Request for Entered in Error Status

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000010001

Response

Status: 200 OK

{
  "resourceType": "Immunization",
  "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000010001",
  "meta": {
    "lastUpdated": "2021-05-24T17:10:00-04:00"
  },
  "status": "entered-in-error",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "10",
        "display": "IPV"
      }
    ],
    "text": "IPV"
  },
  "patient": {
    "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
    "display": "Lancelot,Kaycee Mason"
  },
  "occurrenceDateTime": "2020-04-07",
  "primarySource": false,
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:entered-in-error;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:10 <b>Display</b>:IPV ;<br /><b>Occurrence</b>:2020-04-07;<br /><b>Primary Source</b>:false;<br /></div>"
  }
}

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.

Errors

The common errors and OperationOutcomes may be returned.

Patient Authorization Request for Not Done Status

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Immunization/4C05F5F357EE44FC874C0CF4AB249F99.000001001008000088001

Response

Status: 200 OK

{
  "resourceType": "Immunization",
  "id": "4C05F5F357EE44FC874C0CF4AB249F99.000001001008000088001",
  "meta": {
    "lastUpdated": "2021-05-24T17:04:00-04:00"
  },
  "status": "not-done",
  "statusReason": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "PATOBJ",
        "display": "patient objection"
      }
    ]
  },
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "88",
        "display": "influenza, NOS"
      }
    ],
    "text": "influenza, NOS"
  },
  "patient": {
    "reference": "Patient/4C05F5F357EE44FC874C0CF4AB249F99",
    "display": "Lancelot,Kaycee Mason"
  },
  "_occurrenceDateTime": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    ]
  },
  "primarySource": false,
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Immunization</b><br /><b>Patient</b>:Lancelot,Kaycee Mason;<br /><b>Status</b>:not-done;<br /><b>Reason Not Done</b>:patient objection;<br /><b>Vaccine Code</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/cvx <b>Code</b>:88 <b>Display</b>:influenza, NOS ;<br /><b>Occurrence</b>:Data absent, Reason: unknown;<br /><b>Primary Source</b>:false;<br /></div>"
  }
}

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.

Errors

The common errors and OperationOutcomes may be returned.