QI-Core Implementation Guide
6.0.0-ballot - ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.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><b>Generated Narrative: Immunization</b><a name=\"example\"> </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;example&quot; </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-qicore-immunization.html\">QICore Immunization</a></p></div><p><b>identifier</b>: id:\u00a0urn: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> &quot; CHALMERS&quot;</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> &quot;South Wing, second floor&quot;</p><p><b>manufacturer</b>: <a href=\"Organization-example.html\">Organization/example</a> &quot;Health Level Seven International&quot;</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/5.0.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/5.0.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/5.0.0/CodeSystem-v2-0443.html\">providerRole</a>#OP)</span></p><p><b>actor</b>: <a href=\"Practitioner-example.html\">Practitioner/example</a> &quot; 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.0.0/CodeSystem-v2-0443.html\">providerRole</a>#AP)</span></p><p><b>actor</b>: <a href=\"Practitioner-example.html\">Practitioner/example</a> &quot; CAREFUL&quot;</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 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/example</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/example</a> &quot;Health Level Seven International&quot;</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>"
  },
  "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
    }
  ]
}