This page is part of the Quality Improvement Core Framework (v2.1.0: STU 3 Ballot 1) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

Example: Immunization-qicore-immunization-example

Formats: XML, JSON, Turtle

<Immunization xmlns="http://hl7.org/fhir">
  <id value="qicore-immunization-example"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>
        <strong>id</strong>: example      
      </p>
      <p>
        <strong>identifier</strong>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234      
      </p>
      <p>
        <strong>status</strong>: completed      
      </p>
      <p>
        <strong>notGiven</strong>: false      
      </p>
      <p>
        <strong>vaccineCode</strong>: { urn:oid:1.2.36.1.2001.1005.17 code 'FLUVAX' = 'Fluvax' }      
      </p>
      <p>
        <strong>patient</strong>:         
        <a href="Patient-qicore-patient-example.html">Patient/example</a>
      </p>
      <p>
        <strong>encounter</strong>:         
        <a href="Encounter-qicore-encounter-example.html">Encounter/example</a>
      </p>
      <p>
        <strong>date</strong>: 10/01/2013      
      </p>
      <p>
        <strong>primarySource</strong>: true      
      </p>
      <p>
        <strong>location</strong>:         
        <a href="Location-qicore-location-example.html">Location/example</a>
      </p>
      <p>
        <strong>manufacturer</strong>:         
        <a href="Organization-qicore-organization-example.html">Organization/example</a>
      </p>
      <p>
        <strong>lotNumber</strong>: AAJN11K      
      </p>
      <p>
        <strong>expirationDate</strong>: 15/02/2015      
      </p>
      <p>
        <strong>site</strong>: { http://hl7.org/fhir/v3/ActSite code 'LA' = 'left arm' }      
      </p>
      <p>
        <strong>route</strong>: { http://hl7.org/fhir/v3/RouteOfAdministration code 'IM' = 'Injection, intramuscular' }      
      </p>
      <p>
        <strong>doseQuantity</strong>: 5 mg        
        <span>(Details: UCUM code mg = 'mg')</span>
      </p>
      <blockquote>
        <p>
          <strong>practitioner</strong>
        </p>
        <p>
          <strong>role</strong>: Ordering Provider: { http://hl7.org/fhir/v2/0443 code 'OP' = 'Ordering Provider' }        
        </p>
        <p>
          <strong>actor</strong>:           
          <a href="Practitioner-qicore-practitioner-example.html">Practitioner/example</a>
        </p>
      </blockquote>
      <blockquote>
        <p>
          <strong>practitioner</strong>
        </p>
        <p>
          <strong>role</strong>: { http://hl7.org/fhir/v2/0443 code 'AP' = 'Administering Provider' }        
        </p>
        <p>
          <strong>actor</strong>:           
          <a href="Practitioner-qicore-practitioner-example.html">Practitioner/example</a>
        </p>
      </blockquote>
      <p>
        <strong>note</strong>: Notes on adminstration of vaccine      
      </p>
      <h3>Explanations</h3>
      <table>
        <tr>
          <td>-</td>
          <td>
            <strong>Reason</strong>
          </td>
        </tr>
        <tr>
          <td>*</td>
          <td>Procedure to meet occupational requirement: { SNOMED CT code '429060002' = 'Procedure to meet occupational requirement' }</td>
        </tr>
      </table>
      <h3>Reactions</h3>
      <table>
        <tr>
          <td>-</td>
          <td>
            <strong>Date</strong>
          </td>
          <td>
            <strong>Detail</strong>
          </td>
          <td>
            <strong>Reported</strong>
          </td>
        </tr>
        <tr>
          <td>*</td>
          <td>10/01/2013</td>
          <td>
            <a href="Observation-qicore-observation-example.html">Observation/example</a>
          </td>
          <td>true</td>
        </tr>
      </table>
      <h3>VaccinationProtocols</h3>
      <table>
        <tr>
          <td>-</td>
          <td>
            <strong>DoseSequence</strong>
          </td>
          <td>
            <strong>Description</strong>
          </td>
          <td>
            <strong>Authority</strong>
          </td>
          <td>
            <strong>Series</strong>
          </td>
          <td>
            <strong>SeriesDoses</strong>
          </td>
          <td>
            <strong>TargetDisease</strong>
          </td>
          <td>
            <strong>DoseStatus</strong>
          </td>
          <td>
            <strong>DoseStatusReason</strong>
          </td>
        </tr>
        <tr>
          <td>*</td>
          <td>1</td>
          <td>Vaccination Protocol Sequence 1</td>
          <td>
            <a href="Organization-qicore-organization-example.html">Organization/example</a>
          </td>
          <td>Vaccination Series 1</td>
          <td>2</td>
          <td>Gestational rubella syndrome { SNOMED CT code '1857005' = 'Gestational rubella syndrome }</td>
          <td>Counts { http://hl7.org/fhir/STU3/vaccination-protocol-dose-status code 'count' = 'Counts' }</td>
          <td>Cold chain break { http://hl7.org/fhir/STU3/vaccination-protocol-dose-status-reason code 'coldchbrk' = 'Cold chain break' }          </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/qicore-patient-example"/>
  </patient>
  <encounter>
    <reference value="Encounter/qicore-encounter-example"/>
  </encounter>
  <date value="2013-01-10"/>
  <primarySource value="true"/>
  <location>
    <reference value="Location/qicore-location-example"/>
  </location>
  <manufacturer>
    <reference value="Organization/qicore-organization-example"/>
  </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/qicore-practitioner-example"/>
    </actor>
  </practitioner>
  <practitioner>
    <role>
      <coding>
        <system value="http://hl7.org/fhir/v2/0443"/>
        <code value="AP"/>
      </coding>
    </role>
    <actor>
      <reference value="Practitioner/qicore-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/qicore-observation-example"/>
    </detail>
    <reported value="true"/>
  </reaction>
  <vaccinationProtocol>
    <doseSequence value="1"/>
    <description value="Vaccination Protocol Sequence 1"/>
    <authority>
      <reference value="Organization/qicore-organization-example"/>
    </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>