QI-Core Implementation Guide
4.1.1 - STU 4.1.1 US

This page is part of the Quality Improvement Core Framework (v4.1.1: STU 4) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Immunization example - XML Representation

Raw xml | Download



<Immunization xmlns="http://hl7.org/fhir">
  <id value="example"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource "example" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-qicore-immunization.html">QICoreImmunization</a></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 style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (unknown#FLUVAX)</span></p><p><b>patient</b>: <a href="Patient-example.html">Patient/example</a> " CHALMERS"</p><p><b>encounter</b>: <a href="Encounter-example.html">Encounter/example</a></p><p><b>occurrence</b>: 2013-01-01</p><p><b>recorded</b>: 2013-01-10</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a href="Location-example.html">Location/example</a> "South Wing, second floor"</p><p><b>manufacturer</b>: <a href="Organization-example.html">Organization/example</a> "Health Level Seven International"</p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 2015-02-15</p><p><b>site</b>: left arm <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-ActSite.html">ActSite</a>#LA)</span></p><p><b>route</b>: Injection, intramuscular <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-RouteOfAdministration.html">RouteOfAdministration</a>#IM)</span></p><p><b>doseQuantity</b>: 5 mg<span style="background: LightGoldenRodYellow"> (Details: UCUM code mg = 'mg')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-v2-0443.html">providerRole</a>#OP)</span></p><p><b>actor</b>: <a href="Practitioner-example.html">Practitioner/example</a> " CAREFUL"</p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-v2-0443.html">providerRole</a>#AP)</span></p><p><b>actor</b>: <a href="Practitioner-example.html">Practitioner/example</a> " CAREFUL"</p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: Procedure to meet occupational requirement <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#429060002)</span></p><h3>Reactions</h3><table class="grid"><tr><td>-</td><td><b>Date</b></td><td><b>Detail</b></td><td><b>Reported</b></td></tr><tr><td>*</td><td>2013-01-10</td><td><a href="Observation-example.html">Observation/example</a></td><td>true</td></tr></table><h3>ProtocolApplieds</h3><table class="grid"><tr><td>-</td><td><b>Series</b></td><td><b>Authority</b></td><td><b>TargetDisease</b></td><td><b>DoseNumber[x]</b></td><td><b>SeriesDoses[x]</b></td></tr><tr><td>*</td><td>Vaccination Series 1</td><td><a href="Organization-example.html">Organization/example</a> "Health Level Seven International"</td><td>Gestational rubella syndrome <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#1857005)</span></td><td>1</td><td>2</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"/>
  <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>
  <occurrenceDateTime value="2013-01-01"/>
  <recorded value="2013-01-10"/>
  <primarySource value="true"/>
  <location>
    <reference value="Location/example"/>
  </location>
  <manufacturer>
    <reference value="Organization/example"/>
  </manufacturer>
  <lotNumber value="AAJN11K"/>
  <expirationDate value="2015-02-15"/>
  <site>
    <coding>
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActSite"/>
      <code value="LA"/>
      <display value="left arm"/>
    </coding>
  </site>
  <route>
    <coding>
      <system
              value="http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"/>
      <code value="IM"/>
      <display value="Injection, intramuscular"/>
    </coding>
  </route>
  <doseQuantity>
    <value value="5"/>
    <system value="http://unitsofmeasure.org"/>
    <code value="mg"/>
  </doseQuantity>
  <performer>
    <function>
      <coding>
        <system value="http://terminology.hl7.org/CodeSystem/v2-0443"/>
        <code value="OP"/>
      </coding>
    </function>
    <actor>
      <reference value="Practitioner/example"/>
    </actor>
  </performer>
  <performer>
    <function>
      <coding>
        <system value="http://terminology.hl7.org/CodeSystem/v2-0443"/>
        <code value="AP"/>
      </coding>
    </function>
    <actor>
      <reference value="Practitioner/example"/>
    </actor>
  </performer>
  <note>
    <text value="Notes on adminstration of vaccine"/>
  </note>
  <reasonCode>
    <coding>
      <system value="http://snomed.info/sct"/>
      <code value="429060002"/>
    </coding>
  </reasonCode>
  <reaction>
    <date value="2013-01-10"/>
    <detail>
      <reference value="Observation/example"/>
    </detail>
    <reported value="true"/>
  </reaction>
<!--  Don't know where this goes in R4... isSubpotent and isSubpotentReason? 
    <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>  -->
  <protocolApplied>
    <series value="Vaccination Series 1"/>
    <authority>
      <reference value="Organization/example"/>
    </authority>
    <targetDisease>
      <coding>
        <system value="http://snomed.info/sct"/>
        <code value="1857005"/>
      </coding>
    </targetDisease>
    <doseNumberPositiveInt value="1"/>
    <seriesDosesPositiveInt value="2"/>
  </protocolApplied>
</Immunization>