QI-Core Implementation Guide
7.0.0-ballot - STU7 Ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v7.0.0-ballot: STU7 (v7.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

: Immunization example - JSON Representation

Raw json | Download


{
  "resourceType" : "Immunization",
  "id" : "example",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Immunization example</b></p><a name=\"example\"> </a><a name=\"hcexample\"> </a><a name=\"example-en-US\"> </a><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.txt \r\n\r\nThis 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: \r\n\r\nNote 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.\r\n\r\nThis 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-example.html\">Jim Chalmers  Male, DoB: 1974-12-25 ( Medical record number\u00a0(use:\u00a0usual,\u00a0period:\u00a02001-05-06 --&gt; (ongoing)))</a></p><p><b>encounter</b>: <a href=\"Encounter-example.html\">Encounter: status = in-progress; class = inpatient encounter (ActCode#IMP); type = Initial hospital inpatient or observation care, per day, for the evaluation and management of a patient, which requires a medically appropriate history and/or examination and high level of medical decision making. When using total time on the date of the encounter for code selection, 75 minutes must be met or exceeded.</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 South Wing, second floor</a></p><p><b>manufacturer</b>: <a href=\"Organization-example.html\">Organization Health Level Seven International</a></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><blockquote><p><b>performer</b></p><p><b>function</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v2-0443 OP}\">Ordering Provider</span></p><p><b>actor</b>: <a href=\"Practitioner-example.html\">Practitioner Adam Careful </a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v2-0443 AP}\">Administering Provider</span></p><p><b>actor</b>: <a href=\"Practitioner-example.html\">Practitioner Adam Careful </a></p></blockquote><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><h3>Reactions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Date</b></td><td><b>Detail</b></td><td><b>Reported</b></td></tr><tr><td style=\"display: none\">*</td><td>2013-01-10</td><td><a href=\"Observation-example.html\">Observation Hemoglobin [Mass/volume] in Venous blood</a></td><td>true</td></tr></table><h3>ProtocolApplieds</h3><table class=\"grid\"><tr><td style=\"display: none\">-</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 style=\"display: none\">*</td><td>Vaccination Series 1</td><td><a href=\"Organization-example.html\">Organization Health Level Seven International</a></td><td><span title=\"Codes:{http://snomed.info/sct 1857005}\">Gestational rubella syndrome</span></td><td>1</td><td>2</td></tr></table></div>"
  },
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
    }
  ],
  "status" : "completed",
  "vaccineCode" : {
    "coding" : [
      {
        "system" : "urn:oid:1.2.36.1.2001.1005.17",
        "code" : "FLUVAX"
      }
    ],
    "text" : "Fluvax (Influenza)"
  },
  "patient" : {
    🔗 "reference" : "Patient/example"
  },
  "encounter" : {
    🔗 "reference" : "Encounter/example"
  },
  "occurrenceDateTime" : "2013-01-01",
  "recorded" : "2013-01-10",
  "primarySource" : true,
  "location" : {
    🔗 "reference" : "Location/example"
  },
  "manufacturer" : {
    🔗 "reference" : "Organization/example"
  },
  "lotNumber" : "AAJN11K",
  "expirationDate" : "2015-02-15",
  "site" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-ActSite",
        "code" : "LA",
        "display" : "left arm"
      }
    ]
  },
  "route" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
        "code" : "IM",
        "display" : "Injection, intramuscular"
      }
    ]
  },
  "doseQuantity" : {
    "value" : 5,
    "system" : "http://unitsofmeasure.org",
    "code" : "mg"
  },
  "performer" : [
    {
      "function" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v2-0443",
            "code" : "OP"
          }
        ]
      },
      "actor" : {
        🔗 "reference" : "Practitioner/example"
      }
    },
    {
      "function" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v2-0443",
            "code" : "AP"
          }
        ]
      },
      "actor" : {
        🔗 "reference" : "Practitioner/example"
      }
    }
  ],
  "note" : [
    {
      "text" : "Notes on adminstration of vaccine"
    }
  ],
  "reasonCode" : [
    {
      "coding" : [
        {
          "system" : "http://snomed.info/sct",
          "code" : "429060002"
        }
      ]
    }
  ],
  "reaction" : [
    {
      "date" : "2013-01-10",
      "detail" : {
        🔗 "reference" : "Observation/example"
      },
      "reported" : true
    }
  ],
  "protocolApplied" : [
    //  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> 
    {
      "series" : "Vaccination Series 1",
      "authority" : {
        🔗 "reference" : "Organization/example"
      },
      "targetDisease" : [
        {
          "coding" : [
            {
              "system" : "http://snomed.info/sct",
              "code" : "1857005"
            }
          ]
        }
      ],
      "doseNumberPositiveInt" : 1,
      "seriesDosesPositiveInt" : 2
    }
  ]
}