Da Vinci Payer Data Exchange
2.0.0 - STU2 United States of America flag

This page is part of the Da Vinci Payer Data Exchange (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

US Core Immunization

Previous Page - US Core Goal

Where a Health Plan has access to structured and coded Immunization information for a member, the health plan SHALL present the information using the US Core Immunization resource when information is available in a structured and coded form.

The essential fields (Must Support or Cardinality greater than 0..*) to be provided in the US Core Immunization resource are:

R4 Element Name Cardinality Type
Immunization.status status 1..1 code
Immunization.statusReason statusReason 0..1 CodeableConcept
Immunization.vaccineCode vaccineCode 1..1 CodeableConcept
Immunization.patient patient 1..1 Reference(US Core Patient Profile)
Immunization.occurrence[x] occurrence[x] 1..1  
Immunization.primarySource primarySource 1..1 boolean
Immunization.performer.actor actor 1..1 Reference(Practitioner | PractitionerRole | Organization)
Immunization.protocolApplied.doseNumber[x] doseNumber[x] 1..1  

Table Definition

Example Immunization Resource:

An example mapping of an Immunization resource is shown below:

{
  "resourceType" : "Immunization",
  "id" : "imm-1",
  "meta" : {
    "profile" : [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">
Generated Narrative with Details
id: imm-1
meta: 
status: completed
vaccineCode: influenza, injectable, quadrivalent, contains preservative <span style=\"background: LightGoldenRodYellow\">(Details : {http://hl7.org/fhir/sid/cvx code '158' = 'influenza, injectable, quadrivalent', given as 'influenza, injectable, quadrivalent, contains preservative'}; {http://hl7.org/fhir/sid/ndc code '49281-0621-15' = '49281-0621-15', given as 'FLUZONE QUADRIVALENT'})</span>
patient: <a href=\"Patient-example.html\">Amy Shaw. Generated Summary: id: example; Medical Record Number = 1032702 (USUAL); active; Amy V. Shaw ; ph: 555-555-5555(HOME), amy.shaw@example.com; gender: female; birthDate: Feb 20, 2007</a>
occurrence: Jan 8, 2016, 12:00:00 AM
primarySource: false
</div>"
  },
  "status" : "completed",
  "vaccineCode" : {
    "coding" : [
      {
        "system" : "http://hl7.org/fhir/sid/cvx",
        "code" : "158",
        "display" : "influenza, injectable, quadrivalent, contains preservative"
      },
      {
        "system" : "http://hl7.org/fhir/sid/ndc",
        "code" : "49281-0621-15",
        "display" : "FLUZONE QUADRIVALENT"
      }
    ]
  },
  "patient" : {
    "reference" : "Patient/example",
    "display" : "Amy Shaw"
  },
  "occurrenceDateTime" : "2016-01-08",
  "primarySource" : false
}

Next Page - US Core ImplantableDevice