Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

: General Immunization Example - JSON Representation

Raw json | Download


{
  "resourceType" : "Immunization",
  "id" : "Example1",
  "meta" : {
    "versionId" : "1917088425159200",
    "lastUpdated" : "2020-09-30T12:33:45.510+05:30",
    "profile" : [
      🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"🔗 ,
      "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile"
    ],
    "security" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
        "code" : "N",
        "display" : "Normal"
      }
    ],
    "tag" : [
      {
        "system" : "https://docs.mydata.athenahealth.com/fhir-r4/codesystem/athenaFlex/EditTags",
        "code" : "New",
        "display" : "New"
      },
      {
        "system" : "https://docs.mydata.athenahealth.com/fhir-r4/codesystem/athenaFlex/EditTags",
        "code" : "Pencil",
        "display" : "Pencil"
      },
      {
        "system" : "https://docs.mydata.athenahealth.com/fhir-r4/codesystem/athenaFlex/EditTags",
        "code" : "NewPencil",
        "display" : "New Pencil"
      }
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Immunization Example1</b></p><a name=\"Example1\"> </a><a name=\"hcExample1\"> </a><a name=\"Example1-en-US\"> </a><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\">version: versionId: id (PrimitiveType/Immunization.meta.versionId): element = id -&gt; versionId=id[1917088425159200]; Last updated: 2020-09-30 12:33:45+0530</p><p style=\"margin-bottom: 0px\">Profiles: <a href=\"http://hl7.org/fhir/us/core/STU3.1/StructureDefinition-us-core-immunization.html\">US Core Immunization Profile</a>, <a href=\"StructureDefinition-athena-immunization-profile.html\">Immunization event information</a></p><p style=\"margin-bottom: 0px\">Tags: New (Details: EditTags code New  = ' New ', stated as ' New '), Pencil (Details: EditTags code Pencil  = ' Pencil ', stated as ' Pencil '), New Pencil (Details: EditTags code NewPencil  = ' NewPencil ', stated as ' New Pencil ')</p><p style=\"margin-bottom: 0px\">Security Label: Normal (Details: Confidentiality code N  = ' normal ', stated as ' Normal ')</p></div><p><b>identifier</b>: Unspecified Identifier/1917088425159200</p><p><b>status</b>: Completed</p><p><b>vaccineCode</b>: <span title=\"Codes:{http://hl7.org/fhir/sid/cvx 110}, {http://hl7.org/fhir/sid/mvx SKB}\">DTaP-hepatitis B and poliovirus vaccine</span></p><p><b>patient</b>: <a href=\"Patient-Example1.html\">Robert S Benson (official) Male, DoB: 1974-05-21 ( Medical record number)</a></p><p><b>encounter</b>: <a href=\"Encounter-Example1.html\">Encounter: extension = No display for Extension ,No display for Extension ,No display for Extension ; status = finished; class = ambulatory (ActCode#AMB); type = Office Visit; priority = routine; period = 2020-08-17 21:04:20-0600 --&gt; 2020-08-17 21:07:17-0600</a></p><p><b>occurrence</b>: 2017-12-09 00:00:00+0530</p><p><b>primarySource</b>: false</p><p><b>reportOrigin</b>: <span title=\"Codes:{https://www.hl7.org/fhir/codesystem-immunization-origin recall}\">Parent/Guardian/Patient Recall</span></p><p><b>location</b>: <a href=\"Location-Example1.html\">Location WC</a></p><p><b>lotNumber</b>: 12345</p><p><b>expirationDate</b>: 2017-12-31</p><p><b>site</b>: <span title=\"Codes:{http://snomed.info/sct 89644007}\">Left ear structure</span></p><p><b>route</b>: <span title=\"Codes:{http://ncimeta.nci.nih.gov C38238}\">ID</span></p><p><b>doseQuantity</b>: 1.5 %<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM  code% = '%')</span></p><h3>Performers</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Actor</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"Practitioner-Example1.html\">Practitioner Harry S. Winston </a></td></tr></table><p><b>reasonCode</b>: <span title=\"Codes:\">Administered third dose, Series 3</span></p><h3>Reactions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Date</b></td><td><b>Detail</b></td></tr><tr><td style=\"display: none\">*</td><td>2018-03-07 00:00:00+0530</td><td>anaphylaxis</td></tr></table><h3>ProtocolApplieds</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Series</b></td><td><b>DoseNumber[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>Hepatitis B</td><td>3</td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-VFCEligibility",
      "valueString" : "V24"
    },
    {
      "url" : "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven",
      "valueBoolean" : false
    }
  ],
  "identifier" : [
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code" : "U",
            "display" : "Unspecified Identifier"
          }
        ],
        "text" : "Unspecified Identifier"
      },
      "system" : "https://docs.mydata.athenahealth.com/fhir-r4/athenaFlex/namingsystem/ImmunizationId/Training",
      "value" : "1917088425159200"
    }
  ],
  "status" : "completed",
  "_status" : {
    "extension" : [
      {
        "url" : "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-originalCode",
        "valueCoding" : {
          "system" : "https://docs.mydata.athenahealth.com/fhir-r4/athenaFlex/codesystem/immunizationgivenstatus",
          "code" : "YN",
          "display" : "Completed"
        }
      }
    ]
  },
  "vaccineCode" : {
    "coding" : [
      {
        "system" : "http://hl7.org/fhir/sid/cvx",
        "code" : "110",
        "display" : "DTaP-hepatitis B and poliovirus vaccine"
      },
      {
        "system" : "http://hl7.org/fhir/sid/mvx",
        "code" : "SKB",
        "display" : "GlaxoSmithKline"
      }
    ]
  },
  "patient" : {
    🔗 "reference" : "Patient/Example1"
  },
  "encounter" : {
    🔗 "reference" : "Encounter/Example1"
  },
  "occurrenceDateTime" : "2017-12-09T00:00:00.000+05:30",
  "primarySource" : false,
  "reportOrigin" : {
    "coding" : [
      {
        "system" : "https://www.hl7.org/fhir/codesystem-immunization-origin",
        "code" : "recall",
        "display" : "Parent/Guardian/Patient Recall"
      }
    ],
    "text" : "Parent/Guardian/Patient Recall"
  },
  "location" : {
    🔗 "reference" : "Location/Example1"
  },
  "lotNumber" : "12345",
  "expirationDate" : "2017-12-31",
  "site" : {
    "coding" : [
      {
        "system" : "http://snomed.info/sct",
        "code" : "89644007",
        "display" : "Left ear structure"
      }
    ],
    "text" : "Left ear structure"
  },
  "route" : {
    "coding" : [
      {
        "system" : "http://ncimeta.nci.nih.gov",
        "code" : "C38238",
        "display" : "ID"
      }
    ],
    "text" : "ID"
  },
  "doseQuantity" : {
    "value" : 1.5,
    "unit" : "%",
    "system" : "http://unitsofmeasure.org",
    "code" : "%"
  },
  "performer" : [
    {
      "actor" : {
        🔗 "reference" : "Practitioner/Example1"
      }
    }
  ],
  "reasonCode" : [
    {
      "text" : "Administered third dose, Series 3"
    }
  ],
  "reaction" : [
    {
      "date" : "2018-03-07T00:00:00+05:30",
      "detail" : {
        "display" : "anaphylaxis"
      }
    }
  ],
  "protocolApplied" : [
    {
      "series" : "Hepatitis B",
      "doseNumberPositiveInt" : 3
    }
  ]
}