This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
Example of Immunization
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix sct: <http://snomed.info/id/> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- <http://hl7.org/fhir/Immunization/example> a fhir:Immunization; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "example"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.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>date</b>: 10/01/2013</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>wasNotGiven</b>: false</p><p><b>primarySource</b>: true</p><p><b>performer</b>: <a>Practitioner/example</a></p><p><b>requester</b>: <a>Practitioner/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>location</b>: <a>Location/1</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><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 (procedure) <span>(Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement (procedure))</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>Congenital rubella syndrome (disorder) <span>(Details : {SNOMED CT code '1857005' = 'Congenital rubella syndrome (disorder))</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>" ]; fhir:Immunization.identifier [ fhir:index 0; fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234" ] ]; fhir:Immunization.status [ fhir:value "completed"]; fhir:Immunization.date [ fhir:value "2013-01-10"^^xsd:date]; fhir:Immunization.vaccineCode [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "urn:oid:1.2.36.1.2001.1005.17" ]; fhir:Coding.code [ fhir:value "FLUVAX" ] ]; fhir:CodeableConcept.text [ fhir:value "Fluvax (Influenza)" ] ]; fhir:Immunization.patient [ fhir:link <http://hl7.org/fhir/Patient/example>; fhir:Reference.reference [ fhir:value "Patient/example" ] ]; fhir:Immunization.wasNotGiven [ fhir:value "false"^^xsd:boolean]; fhir:Immunization.primarySource [ fhir:value "true"^^xsd:boolean]; fhir:Immunization.performer [ fhir:link <http://hl7.org/fhir/Practitioner/example>; fhir:Reference.reference [ fhir:value "Practitioner/example" ] ]; fhir:Immunization.requester [ fhir:link <http://hl7.org/fhir/Practitioner/example>; fhir:Reference.reference [ fhir:value "Practitioner/example" ] ]; fhir:Immunization.encounter [ fhir:link <http://hl7.org/fhir/Encounter/example>; fhir:Reference.reference [ fhir:value "Encounter/example" ] ]; fhir:Immunization.manufacturer [ fhir:link <http://hl7.org/fhir/Organization/hl7>; fhir:Reference.reference [ fhir:value "Organization/hl7" ] ]; fhir:Immunization.location [ fhir:link <http://hl7.org/fhir/Location/1>; fhir:Reference.reference [ fhir:value "Location/1" ] ]; fhir:Immunization.lotNumber [ fhir:value "AAJN11K"]; fhir:Immunization.expirationDate [ fhir:value "2015-02-15"^^xsd:date]; fhir:Immunization.site [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/v3/ActSite" ]; fhir:Coding.code [ fhir:value "LA" ]; fhir:Coding.display [ fhir:value "left arm" ] ] ]; fhir:Immunization.route [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/v3/RouteOfAdministration" ]; fhir:Coding.code [ fhir:value "IM" ]; fhir:Coding.display [ fhir:value "Injection, intramuscular" ] ] ]; fhir:Immunization.doseQuantity [ fhir:Quantity.value [ fhir:value "5"^^xsd:decimal ]; fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ]; fhir:Quantity.code [ fhir:value "mg" ] ]; fhir:Immunization.note [ fhir:index 0; fhir:Annotation.text [ fhir:value "Notes on adminstration of vaccine" ] ]; fhir:Immunization.explanation [ fhir:Immunization.explanation.reason [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:concept sct:429060002; fhir:Coding.system [ fhir:value "http://snomed.info/sct" ]; fhir:Coding.code [ fhir:value "429060002" ] ] ] ]; fhir:Immunization.reaction [ fhir:index 0; fhir:Immunization.reaction.date [ fhir:value "2013-01-10"^^xsd:date ]; fhir:Immunization.reaction.detail [ fhir:link <http://hl7.org/fhir/Observation/example>; fhir:Reference.reference [ fhir:value "Observation/example" ] ]; fhir:Immunization.reaction.reported [ fhir:value "true"^^xsd:boolean ] ]; fhir:Immunization.vaccinationProtocol [ fhir:index 0; fhir:Immunization.vaccinationProtocol.doseSequence [ fhir:value "1"^^xsd:positiveInteger ]; fhir:Immunization.vaccinationProtocol.description [ fhir:value "Vaccination Protocol Sequence 1" ]; fhir:Immunization.vaccinationProtocol.authority [ fhir:link <http://hl7.org/fhir/Organization/hl7>; fhir:Reference.reference [ fhir:value "Organization/hl7" ] ]; fhir:Immunization.vaccinationProtocol.series [ fhir:value "Vaccination Series 1" ]; fhir:Immunization.vaccinationProtocol.seriesDoses [ fhir:value "2"^^xsd:positiveInteger ]; fhir:Immunization.vaccinationProtocol.targetDisease [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:concept sct:1857005; fhir:Coding.system [ fhir:value "http://snomed.info/sct" ]; fhir:Coding.code [ fhir:value "1857005" ] ] ]; fhir:Immunization.vaccinationProtocol.doseStatus [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/vaccination-protocol-dose-status" ]; fhir:Coding.code [ fhir:value "count" ]; fhir:Coding.display [ fhir:value "Counts" ] ] ]; fhir:Immunization.vaccinationProtocol.doseStatusReason [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/vaccination-protocol-dose-status-reason" ]; fhir:Coding.code [ fhir:value "coldchbrk" ]; fhir:Coding.display [ fhir:value "Cold chain break" ] ] ] ] . <http://hl7.org/fhir/Patient/example> a fhir:Patient . <http://hl7.org/fhir/Practitioner/example> a fhir:Practitioner, fhir:Practitioner . <http://hl7.org/fhir/Encounter/example> a fhir:Encounter . <http://hl7.org/fhir/Organization/hl7> a fhir:Organization, fhir:Organization . <http://hl7.org/fhir/Location/1> a fhir:Location . <http://hl7.org/fhir/Observation/example> a fhir:Observation . # -------------------------------------------------------------------------------------
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.