R6 Ballot (2nd Draft)

Publish-box (todo)

Example Immunization/protocol (JSON)

Public Health Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Patient, Practitioner

Raw JSON (canonical form + also see JSON Format Specification)

Example where the provider indicates the protocol being followed

{
  "resourceType" : "Immunization",
  "id" : "protocol",
  "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" : "http://hl7.org/fhir/sid/cvx",
      "code" : "104"
    }],
    "text" : "Twinrix (HepA/HepB)"
  },
  "manufacturer" : {
    "reference" : {
      "reference" : "Organization/hl7"
    }
  },
  "lotNumber" : "PT123F",
  "expirationDate" : "2018-12-15",
  "patient" : {
    "reference" : "Patient/example"
  },
  "encounter" : {
    "reference" : "Encounter/example"
  },
  "occurrenceDateTime" : "2018-06-18",
  "primarySource" : true,
  "location" : {
    "reference" : "Location/1"
  },
  "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"
    }
  }],
  "isSubpotent" : false,
  "programEligibility" : [{
    "program" : {
      "text" : "VFC"
    },
    "programStatus" : {
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
        "code" : "ineligible"
      }]
    }
  }],
  "fundingSource" : {
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
      "code" : "private"
    }]
  },
  "protocolApplied" : [{
    "series" : "2-dose",
    "targetDisease" : [{
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "40468003"
      }]
    }],
    "doseNumber" : "1"
  },
  {
    "series" : "3-dose",
    "targetDisease" : [{
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "66071002"
      }]
    }],
    "doseNumber" : "2",
    "seriesDoses" : "3"
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.