In FHIR STU3 standard, Immunizations resource describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
Immunizations is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This includes immunization of both humans and animals, but does not include the administration of non-vaccine agents, even those that may have or claim to have immunological effects.
This resource is adapted to represent the CCDS element, immunizations.
Required or some important fields and parameters would be given in the following tables. Operations and parameters of this resource would also be listed.
Resource Element Fields
| Name | Description | Type |
|---|---|---|
| identifier | Business identifier | Identifier |
| status | The status code | code (Immunization Status Codes) |
| notGiven | Flag for whether immunization was given | boolean |
| vaccineCode | Vaccine product administered | CodeableConcept (Vaccine Administered Value Set) |
| date | Vaccination administration date | dateTime |
| patient | Who was immunized | References (Patient) |
| encounter | Encounter administered as part of | References (Encounter) |
| primarySource | Indicates context the data was recorded in | boolean |
| reportOrigin | Indicates the source of a secondarily reported record | CodeableConcept (Procedure Codes (SNOMED CT)) |
| practitioner (BackboneElement) | Who performed event |
role: CodeableConcept (Procedure Performer Role Codes) actor: Reference (Immunization Role Codes) |
Get Immunizations by Patient
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization?patient={id}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization?patient=726
Search Immunizations With Specific Date
For this resource, users are able to search using parameters like date, patient, and practitioner etc. Important searching parameters would be listed in the following table.
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| _id | The Id of the certain resource | string | False |
| identifier | The unique identifier for this resource | string | False |
| date | Vaccination administration date | dateTime | False |
| patient | The Id representing the specific patient related with this resource | integer | True (If the query is concerning a specific patient) |
| practitioner | Who performed event | string | False |
| vaccineCode | Vaccine product administered | string | False |
| status | The status of the immunization | string | False |
This following request format indicates how to get procedures on a specific date, using parameter date.
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization?patient={id}&date={dateTime}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization?patient=726&date=2015-06-22
Search Immunizations With a Date Range
The request format would be like:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization?patient={id}&date=>={dateTime}&date=<{dateTime (later than previous dateTIme)}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization?patient=726&date=>=2015-05-22&date=<2015-12-31
{
"resourceType": "Bundle",
"id": "6a0be3db-0a77-49f4-8d9f-43ff3852793c",
"meta": {
"lastUpdated": "2017-12-26T10:32:35.665-06:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization?date=%3E%3D2015-05-22&date=%3C2015-12-31&patient=726"
}
],
"entry": [
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Immunization/754",
"resource": {
"resourceType": "Immunization",
"id": "754",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-26T09:21:57.000-06:00"
},
"status": "entered-in-error",
"vaccineCode": {
"coding": [
{
"system": "CVX",
"code": "166",
"display": "influenza, intradermal, quadrivalent, preservative free"
}
]
},
"patient": {
"reference": "Patient/726"
},
"encounter": {
"reference": "Encounter/737"
},
"date": "2015-06-22T11:00:00-04:00",
"manufacturer": {
"reference": "Organization/751"
},
"note": [
{
"text": "Immunization was not given - Patient rejected immunization"
}
]
},
"search": {
"mode": "match"
}
}
]
}