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.
The [patient|user|system]/Immunization.r authorization scope is required.
| Name | Description | DataType |
| ID | The id for the Immunization Resource. | Token |
| Response Code | Description |
| 200 OK | The requested Immunization resource was found and is contained within the body of the HTTP response. |
| 400 Bad Request | The server could not understand the request due to invalid syntax. |
| 404 Not Found | The requested resource does not exist. |
| 500 Internal Server Error | The server has encountered a situation it doesn't know how to handle, resulting in an error. |
Example GET syntax of Immunization ResourceID 18:
This would return a Resource like the one below.
{
"resourceType": "Immunization",
"id": "18",
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "16",
"display": "influenza virus vaccine, whole virus"
}
]
},
"patient": {
"reference": "https://localhost:44391/fhir/Patient/66"
},
"occurrenceDateTime": "2010-09-08T00:00:00-05:00",
"primarySource": true,
"manufacturer": {
"display": "Abbott Laboratories"
},
"lotNumber": "12",
"route": {
"coding": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C38238",
"display": "INTRADERMAL"
}
]
},
"performer": [
{
"actor": {
"identifier": {
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "Hl7.Fhir.Model.ResourceReference"
},
"display": "SMX TEST"
}
}
]
}
The [patient|user|system]/Immunization.rs authorization scope is required.
The following additional authorization scopes might be required depending on _revinclude search parameters used:
| Name | Description | DataType |
| patient | The patient for the vaccination record | Reference |
Example SEARCH syntax of Immunization for Patientid 66:
This would return a bundle containing one or more Immunization Resources like the one above.