This page is part of the Quality Improvement Core Framework (v2.0.0: STU 2) 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

{
  "resourceType" : "Immunization",
  "id" : "qicore-immunization-example",
  "text" : {
    "status" : "generated",
    "div" : "<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>"
  },
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
    }
  ],
  "status" : "completed",
  "notGiven" : false,
  "vaccineCode" : {
    "coding" : [
      {
        "system" : "urn:oid:1.2.36.1.2001.1005.17",
        "code" : "FLUVAX"
      }
    ],
    "text" : "Fluvax (Influenza)"
  },
  "patient" : {
    "reference" : "Patient/qicore-patient-example"
  },
  "encounter" : {
    "reference" : "Encounter/qicore-encounter-example"
  },
  "date" : "2013-01-10",
  "primarySource" : true,
  "location" : {
    "reference" : "Location/qicore-location-example"
  },
  "manufacturer" : {
    "reference" : "Organization/qicore-organization-example"
  },
  "lotNumber" : "AAJN11K",
  "expirationDate" : "2015-02-15",
  "site" : {
    "coding" : [
      {
        "system" : "http://hl7.org/fhir/v3/ActSite",
        "code" : "LA",
        "display" : "left arm"
      }
    ]
  },
  "route" : {
    "coding" : [
      {
        "system" : "http://hl7.org/fhir/v3/RouteOfAdministration",
        "code" : "IM",
        "display" : "Injection, intramuscular"
      }
    ]
  },
  "doseQuantity" : {
    "value" : 5,
    "system" : "http://unitsofmeasure.org",
    "code" : "mg"
  },
  "practitioner" : [
    {
      "role" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/v2/0443",
            "code" : "OP"
          }
        ]
      },
      "actor" : {
        "reference" : "Practitioner/qicore-practitioner-example"
      }
    },
    {
      "role" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/v2/0443",
            "code" : "AP"
          }
        ]
      },
      "actor" : {
        "reference" : "Practitioner/qicore-practitioner-example"
      }
    }
  ],
  "note" : [
    {
      "text" : "Notes on adminstration of vaccine"
    }
  ],
  "explanation" : {
    "reason" : [
      {
        "coding" : [
          {
            "system" : "http://snomed.info/sct",
            "code" : "429060002"
          }
        ]
      }
    ]
  },
  "reaction" : [
    {
      "date" : "2013-01-10",
      "detail" : {
        "reference" : "Observation/qicore-observation-example"
      },
      "reported" : true
    }
  ],
  "vaccinationProtocol" : [
    {
      "doseSequence" : 1,
      "description" : "Vaccination Protocol Sequence 1",
      "authority" : {
        "reference" : "Organization/qicore-organization-example"
      },
      "series" : "Vaccination Series 1",
      "seriesDoses" : 2,
      "targetDisease" : [
        {
          "coding" : [
            {
              "system" : "http://snomed.info/sct",
              "code" : "1857005"
            }
          ]
        }
      ],
      "doseStatus" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/vaccination-protocol-dose-status",
            "code" : "count",
            "display" : "Counts"
          }
        ]
      },
      "doseStatusReason" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/vaccination-protocol-dose-status-reason",
            "code" : "coldchbrk",
            "display" : "Cold chain break"
          }
        ]
      }
    }
  ]
}