FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example Immunization/subpotent (XML)

Public Health Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Patient, Practitioner

Raw XML (canonical form + also see XML Format Specification)

Jump past Narrative

Example of a Subpotent Dose (id = "subpotent")

<?xml version="1.0" encoding="UTF-8"?>

<Immunization xmlns="http://hl7.org/fhir">
  <id value="subpotent"/> 
  <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: Immunization</b> <a name="subpotent"> </a> <a name="hcsubpotent"> </a> </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 Immunization &quot;subpotent&quot; </p> </div> <p> <b> identifier</b> : <a href="http://terminology.hl7.org/5.5.0/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes
         defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase)
         and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.t
        xt 

This oid is used as an identifier II.root to indicate the the extension is an absolute
         URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that
         when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid
         or urn:uuid: 

Note that this OID is created to aid with interconversion between CDA and FHIR
         - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear
         more commonly in FHIR.

This OID may also be used in CD.codeSystem.">URI</a> /urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p> <p> <b> status</b> : completed</p> <p> <b> vaccineCode</b> : Hepatitis B <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (unknown#GNHEP)</span> </p> <h3> Manufacturers</h3> <table class="grid"><tr> <td style="display: none">-</td> <td> <b> Reference</b> </td> </tr> <tr> <td style="display: none">*</td> <td> <a href="organization-example.html">Organization/hl7</a>  &quot;Health Level Seven International&quot;</td> </tr> </table> <p> <b> lotNumber</b> : AAJN11K</p> <p> <b> expirationDate</b> : 2015-02-28</p> <p> <b> patient</b> : <a href="patient-example.html">Patient/example</a>  &quot;Peter CHALMERS&quot;</p> <p> <b> encounter</b> : <a href="encounter-example.html">Encounter/example</a> </p> <p> <b> occurrence</b> : 2015-01-15</p> <p> <b> primarySource</b> : true</p> <p> <b> location</b> : <a href="location-example.html">Location/1</a>  &quot;South Wing, second floor&quot;</p> <p> <b> site</b> : left thigh <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.5.0/CodeSystem-v3-ActSite.html">ActSite</a> #LT)</span> </p> <p> <b> route</b> : Injection, intramuscular <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.5.0/CodeSystem-v3-RouteOfAdministration.html">RouteOfAdministration</a> #IM)</span> </p> <p> <b> doseQuantity</b> : 0.5 ml<span style="background: LightGoldenRodYellow"> (Details: UCUM code ml = 'ml')</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/5.5.0/CodeSystem-v2-0443.html">providerRole</a> #OP)</span> </p> <p> <b> actor</b> : <a href="practitioner-example.html">Practitioner/example</a>  &quot;Adam CAREFUL&quot;</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/5.5.0/CodeSystem-v2-0443.html">providerRole</a> #AP)</span> </p> <p> <b> actor</b> : <a href="practitioner-example.html">Practitioner/example</a>  &quot;Adam CAREFUL&quot;</p> </blockquote> <p> <b> note</b> : Notes on adminstration of vaccine</p> <p> <b> isSubpotent</b> : true</p> <p> <b> subpotentReason</b> : Partial Dose <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.5.0/CodeSystem-immunization-subpotent-reason.html">Immunization Subpotent Reason</a> #partialdose)</span> </p> <h3> ProgramEligibilities</h3> <table class="grid"><tr> <td style="display: none">-</td> <td> <b> Program</b> </td> <td> <b> ProgramStatus</b> </td> </tr> <tr> <td style="display: none">*</td> <td> VFC <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> ()</span> </td> <td> Uninsured <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.5.0/CodeSystem-immunization-program-eligibility.html">Immunization Program Eligibility</a> #uninsured)</span> </td> </tr> </table> <p> <b> fundingSource</b> : Private <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.5.0/CodeSystem-immunization-funding-source.html">Immunization Funding Source</a> #private)</span> </p> </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="GNHEP"/> 
    </coding> 
    <text value="Hepatitis B"/> 
  </vaccineCode> 
  <manufacturer> 
    <reference> 
      <reference value="Organization/hl7"/> 
    </reference> 
  </manufacturer> 
  <lotNumber value="AAJN11K"/> 
  <expirationDate value="2015-02-28"/> 
  <patient> 
    <reference value="Patient/example"/> 
  </patient> 
  <encounter> 
    <reference value="Encounter/example"/> 
  </encounter> 
  <occurrenceDateTime value="2015-01-15"/> 
  <primarySource value="true"/> 
  <location> 
    <reference value="Location/1"/> 
  </location> 
  <site> 
    <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActSite"/> 
      <code value="LT"/> 
      <display value="left thigh"/> 
    </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="0.5"/> 
    <system value="http://unitsofmeasure.org"/> 
    <code value="ml"/> 
  </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> 
  <isSubpotent value="true"/> 
  <subpotentReason> 
    <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/immunization-subpotent-reason"/> 
      <code value="partialdose"/> 
    </coding> 
  </subpotentReason>     
  <programEligibility> 
    <program> 
      <text value="VFC"/> 
    </program> 
    <programStatus> 
      <coding> 
        <system value="http://terminology.hl7.org/CodeSystem/immunization-program-eligibility"/> 
        <code value="uninsured"/> 
      </coding> 
    </programStatus> 
  </programEligibility> 
  <fundingSource> 
    <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/immunization-funding-source"/> 
      <code value="private"/> 
    </coding> 
  </fundingSource> 
</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.