Immunization - FHIR Resource (r4)
This Immunization Resource uses the FHIR API standard for access and structure.
Validate an Immunization FHIR Resource (r4)
Resource Attributes
| Attribute | Field is list | Type | Description |
|---|---|---|---|
doseQuantity | false | SimpleQuantity | # Amount of vaccine administered |
education | true | Data Type | # Educational material presented to patient |
encounter | false | Reference | # Encounter immunization was part of |
expirationDate | false | date | # Vaccine expiration date |
fundingSource | false | CodeableConcept | # Funding source for the vaccine |
identifier | true | Identifier | # Business identifier |
isSubpotent | false | boolean | # Dose potency |
location | false | Reference | # Where immunization occurred |
lotNumber | false | string | # Vaccine lot number |
manufacturer | false | Reference | # Vaccine manufacturer |
note | true | Annotation | # Additional immunization notes |
occurrence[x] | false | dateTime|string | #undefined |
patient | false | Reference | # Who was immunized |
performer | true | Data Type | # Who performed event |
primarySource | false | boolean | # Indicates context the data was recorded in |
programEligibility | true | CodeableConcept | # Patient eligibility for a vaccination program |
protocolApplied | true | Data Type | # Protocol followed by the provider |
reaction | true | Data Type | # Details of a reaction that follows immunization |
reasonCode | true | CodeableConcept | # Why immunization occurred |
reasonReference | true | Reference | # Why immunization occurred |
recorded | false | dateTime | # When the immunization was first captured in the subject's record |
reportOrigin | false | CodeableConcept | # Indicates the source of a secondarily reported record |
route | false | CodeableConcept | # How vaccine entered body |
site | false | CodeableConcept | # Body site vaccine was administered |
status | false | code | # completed | entered-in-error | not-done |
statusReason | false | CodeableConcept | # Reason not done |
subpotentReason | true | CodeableConcept | # Reason for being subpotent |
vaccineCode | false | CodeableConcept | # Vaccine product administered |
Immunization Example
{
"resourceType": "Immunization",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Fluvax (Influenza) <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code 'FLUVAX' = 'Fluvax)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 10/01/2013</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 15/02/2015</p><p><b>site</b>: left arm <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code 'LA' = 'left arm', given as 'left arm'})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code 'IM' = 'Injection, intramuscular', given as 'Injection, intramuscular'})</span></p><p><b>doseQuantity</b>: 5 mg<span> (Details: UCUM code mg = 'mg')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'OP' = 'Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'AP' = 'Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement)</span></p><p><b>isSubpotent</b>: true</p><h3>Educations</h3><table><tr><td>-</td><td><b>DocumentType</b></td><td><b>PublicationDate</b></td><td><b>PresentationDate</b></td></tr><tr><td>*</td><td>253088698300010311120702</td><td>02/07/2012</td><td>10/01/2013</td></tr></table><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code 'ineligible' = 'Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code 'private' = 'Private)</span></p></div>"
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "urn:oid:1.2.36.1.2001.1005.17",
"code": "FLUVAX"
}
],
"text": "Fluvax (Influenza)"
},
"patient": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
},
"occurrenceDateTime": "2013-01-10",
"primarySource": true,
"location": {
"reference": "Location/1"
},
"manufacturer": {
"reference": "Organization/hl7"
},
"lotNumber": "AAJN11K",
"expirationDate": "2015-02-15",
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
"code": "LA",
"display": "left arm"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
"code": "IM",
"display": "Injection, intramuscular"
}
]
},
"doseQuantity": {
"value": 5,
"system": "http://unitsofmeasure.org",
"code": "mg"
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "OP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
],
"note": [
{
"text": "Notes on adminstration of vaccine"
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "429060002"
}
]
}
],
"isSubpotent": true,
"education": [
{
"documentType": "253088698300010311120702",
"publicationDate": "2012-07-02",
"presentationDate": "2013-01-10"
}
],
"programEligibility": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
"code": "ineligible"
}
]
}
],
"fundingSource": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
"code": "private"
}
]
}
}Immunization Structure
{
"resourceType" : "Immunization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // R! completed | entered-in-error | not-done
"statusReason" : { CodeableConcept }, // Reason not done
"vaccineCode" : { CodeableConcept }, // R! Vaccine product administered
"patient" : { Reference(Patient) }, // R! Who was immunized
"encounter" : { Reference(Encounter) }, // Encounter immunization was part of
// occurrence[x]: Vaccine administration date. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrenceString" : "<string>",
"recorded" : "<dateTime>", // When the immunization was first captured in the subject's record
"primarySource" : <boolean>, // Indicates context the data was recorded in
"reportOrigin" : { CodeableConcept }, // Indicates the source of a secondarily reported record
"location" : { Reference(Location) }, // Where immunization occurred
"manufacturer" : { Reference(Organization) }, // Vaccine manufacturer
"lotNumber" : "<string>", // Vaccine lot number
"expirationDate" : "<date>", // Vaccine expiration date
"site" : { CodeableConcept }, // Body site vaccine was administered
"route" : { CodeableConcept }, // How vaccine entered body
"doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
"performer" : [{ // Who performed event
"function" : { CodeableConcept }, // What type of performance was done
"actor" : { Reference(Practitioner|PractitionerRole|Organization) } // R! Individual or organization who was performing
}],
"note" : [{ Annotation }], // Additional immunization notes
"reasonCode" : [{ CodeableConcept }], // Why immunization occurred
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport) }], // Why immunization occurred
"isSubpotent" : <boolean>, // Dose potency
"subpotentReason" : [{ CodeableConcept }], // Reason for being subpotent
"education" : [{ // Educational material presented to patient
"documentType" : "<string>", // Educational material document identifier
"reference" : "<uri>", // Educational material reference pointer
"publicationDate" : "<dateTime>", // Educational material publication date
"presentationDate" : "<dateTime>" // Educational material presentation date
}],
"programEligibility" : [{ CodeableConcept }], // Patient eligibility for a vaccination program
"fundingSource" : { CodeableConcept }, // Funding source for the vaccine
"reaction" : [{ // Details of a reaction that follows immunization
"date" : "<dateTime>", // When reaction started
"detail" : { Reference(Observation) }, // Additional information on reaction
"reported" : <boolean> // Indicates self-reported reaction
}],
"protocolApplied" : [{ // Protocol followed by the provider
"series" : "<string>", // Name of vaccine series
"authority" : { Reference(Organization) }, // Who is responsible for publishing the recommendations
"targetDisease" : [{ CodeableConcept }], // Vaccine preventatable disease being targetted
// doseNumber[x]: Dose number within series. One of these 2:
"doseNumberPositiveInt" : "<positiveInt>",
"doseNumberString" : "<string>",
// seriesDoses[x]: Recommended number of doses for immunity. One of these 2:
"seriesDosesPositiveInt" : "<positiveInt>"
"seriesDosesString" : "<string>"
}]
}
Immunization Search Parameters
The following search parameters can be used to query Immunization resources. Just submit them like so:
https://api.1up.health/fhir/r4/Immunization?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
date | date | occurrence |
identifier | text | identifier |
location | reference | location |
lot-number | text | lotNumber |
manufacturer | reference | manufacturer |
patient | reference | patient |
performer | reference | performer.actor |
reaction | reference | reaction.detail |
reaction-date | date | reaction.date |
reason-code | text | reasonCode |
reason-reference | reference | reasonReference |
series | text | protocolApplied.series |
status | text | status |
status-reason | text | statusReason |
target-disease | text | protocolApplied.targetDisease |
vaccine-code | text | vaccineCode |