Immunization

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Response Description

Sample Response

{

  "resourceType": "Immunization",

  "id": "DEV-DEV-11913-5926",

  "meta": {

     "lastUpdated": "2022-11-15T12:00:00-05:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian, Sr. (DEV-DEV-11913)</td></tr><tr><td>Description:</td><td>varicella virus vaccine</td></tr><tr><td>CVX Code:</td><td>21</td></tr><tr><td>Administered:</td><td>11/15/2022</td></tr><tr><td>Note:</td><td>Patient did not scream, flinch, or faint</td></tr></tbody></table></div>"

  },

  "status": "entered-in-error",

  "statusReason": {

     "extension": [

        {

           "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",

           "valueCode": "unknown"

        }

     ]

  },

  "vaccineCode": {

     "coding": [

        {

           "system": "http://hl7.org/fhir/sid/cvx",

           "code": "21",

           "display": "varicella virus vaccine"

        }

     ]

  },

  "primarySource": false,

  "occurrenceDateTime": "2022-11-15",

  "patient": {

     "reference": "Patient/DEV-DEV-11913",

     "display": "Cole Andersonian, Sr. (DEV-DEV-11913)"

  }

}

Immunization.id

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Immunization.meta

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Immunization.text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Immunization.status

Status of the Immunization.

Immunization.statusReason

Indicates the reason the immunization event was not performed.

Immunization.vaccineCode

CVX code of the vaccine that was administered or was to be administered.

Immunization.primarySource

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

Immunization.occurenceDateTime

The date when the vaccine was administered.

Immunization.patient

The patient who either received or did not receive the immunization.

Search

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Immunization?{query string}

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Immunization/{resource id}

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Immunization/_search

•Set the Content-Type header to application/x-www-urlencoded

•The body of the request is a similar query string used in the GET type of request detailed above.

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

Supported Search Parameters

_id

patient

date