This page is part of the FHIR Specification (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R5 R4B R4 R3 R2
| Public Health and Emergency Response Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient, Practitioner |
Raw JSON (canonical form + also see JSON Format Specification)
Example of Immunization
{
"resourceType": "Immunization",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div><p>Resource "example" </p></div><p><b>identifier</b>: id: 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> (unknown#FLUVAX)</span></p><p><b>manufacturer</b>: <a>Organization/hl7</a> "Health Level Seven International"</p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 2015-02-15</p><p><b>patient</b>: <a>Patient/example</a> "Peter CHALMERS"</p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 2013-01-10</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a> "South Wing, second floor"</p><p><b>site</b>: left arm <span> (<a>ActSite</a>#LA)</span></p><p><b>route</b>: Injection, intramuscular <span> (<a>RouteOfAdministration</a>#IM)</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> (<a>providerRole</a>#OP)</span></p><p><b>actor</b>: <a>Practitioner/example</a> "Adam CAREFUL"</p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span> (<a>providerRole</a>#AP)</span></p><p><b>actor</b>: <a>Practitioner/example</a> "Adam CAREFUL"</p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</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>2012-07-02</td><td>2013-01-10</td></tr></table><p><b>programEligibility</b>: Not Eligible <span> (<a>Immunization Program Eligibility</a>#ineligible)</span></p><p><b>fundingSource</b>: Private <span> (<a>Immunization Funding Source</a>#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)"
},
"manufacturer": {
"reference": "Organization/hl7"
},
"lotNumber": "AAJN11K",
"expirationDate": "2015-02-15",
"patient": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
},
"occurrenceDateTime": "2013-01-10",
"primarySource": true,
"location": {
"reference": "Location/1"
},
"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"
}
],
"reason": [
{
"concept": {
"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"
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.