International Patient Access
1.1.0 - STU1 International flag

International Patient Access, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ipa/ and changes regularly. See the Directory of published versions

: IPA Immunization Example - XML Representation

Page standards status: Informative

Raw xml | Download


<Immunization xmlns="http://hl7.org/fhir">
  <id value="ImmExample1"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Immunization ImmExample1</b></p><a name="ImmExample1"> </a><a name="hcImmExample1"> </a><a name="ImmExample1-en-US"> </a><p><b>identifier</b>: <a href="http://terminology.hl7.org/6.0.2/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.txt 

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.">Uniform Resource Identifier (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>: <span title="Codes:{urn:oid:1.2.36.1.2001.1005.17 FLUVAX}">Fluvax (Influenza)</span></p><p><b>patient</b>: <a href="Patient-PatientExample1.html">Meiko Lufhir Jr., PhD Female, DoB: 1978-03-22 ( urn:oid:1.2.840.114350.1.13.861.1.7.5.737384.4399#21890 (use: usual, ))</a></p><p><b>occurrence</b>: 2013-01-10</p><p><b>primarySource</b>: true</p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 2015-02-15</p><p><b>site</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-ActSite LA}">left arm</span></p><p><b>route</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration IM}">Injection, intramuscular</span></p><p><b>doseQuantity</b>: 5 mg<span style="background: LightGoldenRodYellow"> (Details: UCUM  codemg = 'mg')</span></p><h3>Performers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Function</b></td><td><b>Actor</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/v2-0443 OP}">Ordering Provider</span></td><td><a href="Practitioner-PractitionerExample1.html">Practitioner Marty Seeger</a></td></tr></table><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: <span title="Codes:{http://snomed.info/sct 429060002}">Procedure to meet occupational requirement</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="FLUVAX"/>
    </coding>
    <text value="Fluvax (Influenza)"/>
  </vaccineCode>
  <patient>🔗 
    <reference value="Patient/PatientExample1"/>
  </patient>
  <occurrenceDateTime value="2013-01-10"/>
  <primarySource value="true"/>
  <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/PractitionerExample1"/>
    </actor>
  </performer>
  <note>
    <text value="Notes on adminstration of vaccine"/>
  </note>
  <reasonCode>
    <coding>
      <system value="http://snomed.info/sct"/>
      <code value="429060002"/>
    </coding>
  </reasonCode>
</Immunization>