This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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
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 where the provider indicates the protocol being followed
{ "resourceType": "Immunization", "id": "protocol", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><p><b>id</b>: protocol</p><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>: <span>Twinrix (HepA/HepB)</span></p><p><b>manufacturer</b>: <a>Generated Summary: id: hl7; name: Health Level Seven International; alias: HL7 International; ph: (+1) 734-677-7777, fax: (+1) 734-677-6622, hq@HL7.org</a></p><p><b>lotNumber</b>: PT123F</p><p><b>expirationDate</b>: 2018-12-15</p><p><b>patient</b>: <a>Generated Summary: id: example; Medical record number: 12345 (USUAL); active; Peter James Chalmers (OFFICIAL), Jim , Peter James Windsor (MAIDEN); -unknown-(HOME), ph: (03) 5555 6473(WORK), ph: (03) 3410 5613(MOBILE), ph: (03) 5555 8834(OLD); gender: male; birthDate: 1974-12-25; </a></p><p><b>encounter</b>: <a>Generated Summary: id: example; status: in-progress; <span>inpatient encounter</span></a></p><p><b>occurrence</b>: 2018-06-18</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Generated Summary: id: 1; id: B1-S.F2; status: active; name: South Wing, second floor; alias: BU MC, SW, F2, alias: Burgers University Medical Center, South Wing, second floor; description: Second floor of the Old South Wing, formerly in use by Psychiatry; mode: instance; ph: 2328(WORK), fax: 2329(WORK), second wing admissions, http://sampleorg.com/southwing(WORK); <span>Wing</span></a></p><p><b>site</b>: <span>left arm</span></p><p><b>route</b>: <span>Injection, intramuscular</span></p><p><b>doseQuantity</b>: 5 mg</p><blockquote><p><b>performer</b></p><p><b>function</b>: <span>Ordering Provider</span></p><p><b>actor</b>: <a>Generated Summary: id: example; id: 23; active; Adam Careful </a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: <span>Administering Provider</span></p><p><b>actor</b>: <a>Generated Summary: id: example; id: 23; active; Adam Careful </a></p></blockquote><p><b>isSubpotent</b>: false</p><p><b>programEligibility</b>: <span>Not Eligible</span></p><p><b>fundingSource</b>: <span>Private</span></p><blockquote><p><b>protocolApplied</b></p><p><b>series</b>: 2-dose</p><p><b>targetDisease</b>: <span>Viral hepatitis, type A</span></p><p><b>doseNumber</b>: 1</p></blockquote><blockquote><p><b>protocolApplied</b></p><p><b>series</b>: 3-dose</p><p><b>targetDisease</b>: <span>Type B viral hepatitis</span></p><p><b>doseNumber</b>: 2</p><p><b>seriesDoses</b>: 3</p></blockquote></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": "http://hl7.org/fhir/sid/cvx", "code": "104" } ], "text": "Twinrix (HepA/HepB)" }, "manufacturer": { "reference": "Organization/hl7" }, "lotNumber": "PT123F", "expirationDate": "2018-12-15", "patient": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "occurrenceDateTime": "2018-06-18", "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" } } ], "isSubpotent": false, "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" } ] }, "protocolApplied": [ { "series": "2-dose", "targetDisease": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "40468003" } ] } ], "doseNumber": "1" }, { "series": "3-dose", "targetDisease": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "66071002" } ] } ], "doseNumber": "2", "seriesDoses": "3" } ] }
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.