This page is part of the FHIR Specification (v3.0.2: STU 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 R3 R2
Public Health and Emergency Response Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Patient, Practitioner |
Example of Immunization (id = "example")
<Immunization xmlns="http://hl7.org/fhir"> <id value="example"/> <text> <status value="generated"/> <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> </text> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"/> </identifier> <status value="completed"/> <notGiven value="false"/> <vaccineCode> <coding> <system value="urn:oid:1.2.36.1.2001.1005.17"/> <code value="FLUVAX"/> </coding> <text value="Fluvax (Influenza)"/> </vaccineCode> <patient> <reference value="Patient/example"/> </patient> <encounter> <reference value="Encounter/example"/> </encounter> <date value="2013-01-10"/> <primarySource value="true"/> <location> <reference value="Location/1"/> </location> <manufacturer> <reference value="Organization/hl7"/> </manufacturer> <lotNumber value="AAJN11K"/> <expirationDate value="2015-02-15"/> <site> <coding> <system value="http://hl7.org/fhir/v3/ActSite"/> <code value="LA"/> <display value="left arm"/> </coding> </site> <route> <coding> <system value="http://hl7.org/fhir/v3/RouteOfAdministration"/> <code value="IM"/> <display value="Injection, intramuscular"/> </coding> </route> <doseQuantity> <value value="5"/> <system value="http://unitsofmeasure.org"/> <code value="mg"/> </doseQuantity> <practitioner> <role> <coding> <system value="http://hl7.org/fhir/v2/0443"/> <code value="OP"/> </coding> </role> <actor> <reference value="Practitioner/example"/> </actor> </practitioner> <practitioner> <role> <coding> <system value="http://hl7.org/fhir/v2/0443"/> <code value="AP"/> </coding> </role> <actor> <reference value="Practitioner/example"/> </actor> </practitioner> <note> <text value="Notes on adminstration of vaccine"/> </note> <explanation> <reason> <coding> <system value="http://snomed.info/sct"/> <code value="429060002"/> </coding> </reason> </explanation> <reaction> <date value="2013-01-10"/> <detail> <reference value="Observation/example"/> </detail> <reported value="true"/> </reaction> <vaccinationProtocol> <doseSequence value="1"/> <description value="Vaccination Protocol Sequence 1"/> <authority> <reference value="Organization/hl7"/> </authority> <series value="Vaccination Series 1"/> <seriesDoses value="2"/> <targetDisease> <coding> <system value="http://snomed.info/sct"/> <code value="1857005"/> </coding> </targetDisease> <doseStatus> <coding> <system value="http://hl7.org/fhir/vaccination-protocol-dose-status"/> <code value="count"/> <display value="Counts"/> </coding> </doseStatus> <doseStatusReason> <coding> <system value="http://hl7.org/fhir/vaccination-protocol-dose-status-reason"/> <code value="coldchbrk"/> <display value="Cold chain break"/> </coding> </doseStatusReason> </vaccinationProtocol> </Immunization>
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.