FHIR Specifications
Immunization
Description:
A patient’s immunization history, including information on the vaccine and vaccine administration, is provided via the FHIR Immunization resource.This resource contains the functionality to query a patient’s immunization history.
Interaction:
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Immunization/Immunization-Patient1
1.1.2. HTTP Method : GET
1.1.3. Parameter
1.2. Response
{
"resourceType": "Immunization",
"id": "Immunization-Patient1",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"statusReason": {
"coding": [
{
"system": "http://snomed.info/sct"
}
]
},
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "106",
"display": "Tetanus and diptheria toxoids"
}
]
},
"patient": {
"reference": "Patient/3"
},
"occurrenceDateTime": "2012-04-01T00:00:00+00:00",
"primarySource": false,
"location": {
"reference": "Organization/Organization-1"
},
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"
}
]
},
"doseQuantity": {
"value": 0.000
}
}
Encounter Resource Content:
Response Codes:
2. Search
2.1. Request
2.1.1. URL - /mps/fhir/R4/Immunization?_id=Immunization-Patient7
2.1.2. HTTP Method : GET
2.1.3. Parameter
2.2. Response
{
"resourceType": "Bundle",
"id": "1804183c-db19-45e6-9573-60131172701b",
"meta": {
"lastUpdated": "2022-11-21T06:21:22.772+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Immunization?_id=Immunization-Patient7"
}
],
"entry": [
{
"resource": {
"resourceType": "Immunization",
"id": "Immunization-Patient7",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"statusReason": {
"coding": [
{
"system": "http://snomed.info/sct"
}
]
},
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "106",
"display": "Tetanus and diptheria toxoids"
}
]
},
"patient": {
"reference": "Patient/85"
},
"occurrenceDateTime": "2012-01-04T00:00:00+00:00",
"primarySource": false,
"location": {
"reference": "Organization/Organization-1"
},
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"
}
]
},
"doseQuantity": {
"value": 0.000
}
},
"search": {
"mode": "match"
}
}
]
}
| Name | Description | Required/Optional |
|---|---|---|
| Bundle (Bundle) | Resource bundle. (For more information, refer to the FHIR specification.) | Required |
| Entry | A container for a single FHIR resource. | Required |
| Immunization | A single Immunization resource. | Required |
Name
Description
Required/Optional
Immunization Resource Content:
Name
Description
Required/Optional
patient(Reference)
Whether the immunization data is historical and therefore reported by a patient or another system.
Required
entry
An array of entries included in this bundle.
Required
Response Codes:
Response Code
Description
200 OK
The requested 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. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
Product Information
IMS (14.0.SP1)
