Immunization - FHIR Resource (stu3)
This Immunization Resource uses the FHIR API standard for access and structure.
Validate an Immunization FHIR Resource (stu3)
Immunization Attributes
AttributeField is listTypeDescription
Description: completed | entered-in-error
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (Immunization) status FHIR attribute
Description: Amount of vaccine administered
FHIR Version: stu3
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doseQuantity": {
"code": "mg",
"system": "http://unitsofmeasure.org",
"value": 5
}Learn more about the (Immunization) doseQuantity FHIR attribute
Description: Business identifier
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
]Learn more about the (Immunization) identifier FHIR attribute
Description: Who performed event
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"practitioner": [
{
"role": {
"coding": [
{
"code": "OP",
"system": "http://hl7.org/fhir/v2/0443"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"role": {
"coding": [
{
"code": "AP",
"system": "http://hl7.org/fhir/v2/0443"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
]Learn more about the (Immunization) practitioner FHIR attribute
Description: Flag for whether immunization was given
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notGiven": falseLearn more about the (Immunization) notGiven FHIR attribute
Description: Details of a reaction that follows immunization
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reaction": [
{
"date": "2013-01-10",
"reported": true,
"detail": {
"reference": "Observation/example"
}
}
]Learn more about the (Immunization) reaction FHIR attribute
Description: Indicates the source of a secondarily reported record
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reportOrigin": Learn more about the (Immunization) reportOrigin FHIR attribute
Description: Administration/non-administration reasons
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"explanation": {
"reason": [
{
"coding": [
{
"code": "429060002",
"system": "http://snomed.info/sct"
}
]
}
]
}Learn more about the (Immunization) explanation FHIR attribute
Description: Body site vaccine was administered
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"site": {
"coding": [
{
"code": "LA",
"system": "http://hl7.org/fhir/v3/ActSite",
"display": "left arm"
}
]
}Learn more about the (Immunization) site FHIR attribute
Description: Vaccine product administered
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"vaccineCode": {
"text": "Fluvax (Influenza)",
"coding": [
{
"code": "FLUVAX",
"system": "urn:oid:1.2.36.1.2001.1005.17"
}
]
}Learn more about the (Immunization) vaccineCode FHIR attribute
Description: Vaccination notes
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": [
{
"text": "Notes on adminstration of vaccine"
}
]Learn more about the (Immunization) note FHIR attribute
Description: What protocol was followed
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"vaccinationProtocol": [
{
"seriesDoses": 2,
"description": "Vaccination Protocol Sequence 1",
"series": "Vaccination Series 1",
"doseStatusReason": {
"coding": [
{
"code": "coldchbrk",
"system": "http://hl7.org/fhir/vaccination-protocol-dose-status-reason",
"display": "Cold chain break"
}
]
},
"authority": {
"reference": "Organization/hl7"
},
"doseSequence": 1,
"doseStatus": {
"coding": [
{
"code": "count",
"system": "http://hl7.org/fhir/vaccination-protocol-dose-status",
"display": "Counts"
}
]
},
"targetDisease": [
{
"coding": [
{
"code": "1857005",
"system": "http://snomed.info/sct"
}
]
}
]
}
]Learn more about the (Immunization) vaccinationProtocol FHIR attribute
Description: Vaccine lot number
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lotNumber": "AAJN11K"Learn more about the (Immunization) lotNumber FHIR attribute
Description: Where vaccination occurred
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": {
"reference": "Location/1"
}Learn more about the (Immunization) location FHIR attribute
Description: Vaccination administration date
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2013-01-10"Learn more about the (Immunization) date FHIR attribute
Description: Who was immunized
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"reference": "Patient/example"
}Learn more about the (Immunization) patient FHIR attribute
Description: Vaccine manufacturer
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufacturer": {
"reference": "Organization/hl7"
}Learn more about the (Immunization) manufacturer FHIR attribute
Description: Indicates context the data was recorded in
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"primarySource": trueLearn more about the (Immunization) primarySource FHIR attribute
Description: How vaccine entered body
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"route": {
"coding": [
{
"code": "IM",
"system": "http://hl7.org/fhir/v3/RouteOfAdministration",
"display": "Injection, intramuscular"
}
]
}Learn more about the (Immunization) route FHIR attribute
Description: Encounter administered as part of
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/example"
}Learn more about the (Immunization) encounter FHIR attribute
Description: Vaccine expiration date
FHIR Version: stu3
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expirationDate": "2015-02-15"Learn more about the (Immunization) expirationDate FHIR attribute
Immunization 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>notGiven</b>: false</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>date</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://hl7.org/fhir/v3/ActSite code 'LA' = 'left arm', given as 'left arm'})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://hl7.org/fhir/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>practitioner</b></p><p><b>role</b>: Ordering Provider <span>(Details : {http://hl7.org/fhir/v2/0443 code 'OP' = 'Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>practitioner</b></p><p><b>role</b>: Administering Provider <span>(Details : {http://hl7.org/fhir/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><h3>Explanations</h3><table><tr><td>-</td><td><b>Reason</b></td></tr><tr><td>*</td><td>Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement)</span></td></tr></table><h3>Reactions</h3><table><tr><td>-</td><td><b>Date</b></td><td><b>Detail</b></td><td><b>Reported</b></td></tr><tr><td>*</td><td>10/01/2013</td><td><a>Observation/example</a></td><td>true</td></tr></table><h3>VaccinationProtocols</h3><table><tr><td>-</td><td><b>DoseSequence</b></td><td><b>Description</b></td><td><b>Authority</b></td><td><b>Series</b></td><td><b>SeriesDoses</b></td><td><b>TargetDisease</b></td><td><b>DoseStatus</b></td><td><b>DoseStatusReason</b></td></tr><tr><td>*</td><td>1</td><td>Vaccination Protocol Sequence 1</td><td><a>Organization/hl7</a></td><td>Vaccination Series 1</td><td>2</td><td>Gestational rubella syndrome <span>(Details : {SNOMED CT code '1857005' = 'Gestational rubella syndrome)</span></td><td>Counts <span>(Details : {http://hl7.org/fhir/vaccination-protocol-dose-status code 'count' = 'Counts', given as 'Counts'})</span></td><td>Cold chain break <span>(Details : {http://hl7.org/fhir/vaccination-protocol-dose-status-reason code 'coldchbrk' = 'Cold chain break', given as 'Cold chain break'})</span></td></tr></table></div>"
},
"site": {
"coding": [
{
"code": "LA",
"system": "http://hl7.org/fhir/v3/ActSite",
"display": "left arm"
}
]
},
"expirationDate": "2015-02-15",
"practitioner": [
{
"role": {
"coding": [
{
"code": "OP",
"system": "http://hl7.org/fhir/v2/0443"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"role": {
"coding": [
{
"code": "AP",
"system": "http://hl7.org/fhir/v2/0443"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
],
"id": "example",
"note": [
{
"text": "Notes on adminstration of vaccine"
}
],
"location": {
"reference": "Location/1"
},
"status": "completed",
"patient": {
"reference": "Patient/example"
},
"explanation": {
"reason": [
{
"coding": [
{
"code": "429060002",
"system": "http://snomed.info/sct"
}
]
}
]
},
"doseQuantity": {
"code": "mg",
"system": "http://unitsofmeasure.org",
"value": 5
},
"lotNumber": "AAJN11K",
"date": "2013-01-10",
"primarySource": true,
"encounter": {
"reference": "Encounter/example"
},
"manufacturer": {
"reference": "Organization/hl7"
},
"reaction": [
{
"date": "2013-01-10",
"reported": true,
"detail": {
"reference": "Observation/example"
}
}
],
"notGiven": false,
"resourceType": "Immunization",
"route": {
"coding": [
{
"code": "IM",
"system": "http://hl7.org/fhir/v3/RouteOfAdministration",
"display": "Injection, intramuscular"
}
]
},
"vaccineCode": {
"text": "Fluvax (Influenza)",
"coding": [
{
"code": "FLUVAX",
"system": "urn:oid:1.2.36.1.2001.1005.17"
}
]
},
"vaccinationProtocol": [
{
"seriesDoses": 2,
"description": "Vaccination Protocol Sequence 1",
"series": "Vaccination Series 1",
"doseStatusReason": {
"coding": [
{
"code": "coldchbrk",
"system": "http://hl7.org/fhir/vaccination-protocol-dose-status-reason",
"display": "Cold chain break"
}
]
},
"authority": {
"reference": "Organization/hl7"
},
"doseSequence": 1,
"doseStatus": {
"coding": [
{
"code": "count",
"system": "http://hl7.org/fhir/vaccination-protocol-dose-status",
"display": "Counts"
}
]
},
"targetDisease": [
{
"coding": [
{
"code": "1857005",
"system": "http://snomed.info/sct"
}
]
}
]
}
],
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
]
}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
"notGiven" : <boolean>, // R! Flag for whether immunization was given
"vaccineCode" : { CodeableConcept }, // R! Vaccine product administered
"patient" : { Reference(Patient) }, // R! Who was immunized
"encounter" : { Reference(Encounter) }, // Encounter administered as part of
"date" : "<dateTime>", // Vaccination administration date
"primarySource" : <boolean>, // R! Indicates context the data was recorded in
"reportOrigin" : { CodeableConcept }, // Indicates the source of a secondarily reported record
"location" : { Reference(Location) }, // Where vaccination 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
"practitioner" : [{ // Who performed event
"role" : { CodeableConcept }, // What type of performance was done
"actor" : { Reference(Practitioner) } // R! Individual who was performing
}],
"note" : [{ Annotation }], // Vaccination notes
"explanation" : { // Administration/non-administration reasons
"reason" : [{ CodeableConcept }], // Why immunization occurred
"reasonNotGiven" : [{ CodeableConcept }] // Why immunization did not occur
},
"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
}],
"vaccinationProtocol" : [{ // What protocol was followed
"doseSequence" : "<positiveInt>", // Dose number within series
"description" : "<string>", // Details of vaccine protocol
"authority" : { Reference(Organization) }, // Who is responsible for protocol
"series" : "<string>", // Name of vaccine series
"seriesDoses" : "<positiveInt>", // Recommended number of doses for immunity
"targetDisease" : [{ CodeableConcept }], // R! Disease immunized against
"doseStatus" : { CodeableConcept }, // R! Indicates if dose counts towards immunity
"doseStatusReason" : { CodeableConcept } // Why dose does (not) count
}]
}
Immunization Search Parameters
The following search parameters can be used to query Immunization resources. Just submit them like so:
https://api.1up.health/fhir/stu3/Immunization?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
date | date | date |
dose-sequence | number | vaccinationProtocol.doseSequence |
identifier | text | identifier |
location | reference | location |
lot-number | text | lotNumber |
manufacturer | reference | manufacturer |
notgiven | text | notGiven |
patient | reference | patient |
practitioner | reference | practitioner.actor |
reaction | reference | reaction.detail |
reaction-date | date | reaction.date |
reason | text | explanation.reason |
reason-not-given | text | explanation.reasonNotGiven |
status | text | status |
vaccine-code | text | vaccineCode |
