Skip to content

Immunization Profile

Canonical../StructureDefinition/nexus-emr-core-immunization
Statusdraft · 1.26.0
BaseImmunization (constraint)
SourceFSH · JSON

Nexus EMR profile for Immunization resources, aligned with CA-Core+ and CII requirements. Records details about vaccines administered to a patient.

Examples

Avery COVID-19 Vaccination (Prevention) · Avery TDAP

Avery COVID-19 Vaccination (Prevention)

Prevention Immunization for Avery Linwood identified by a nexus-emr-prevention-catalog code; status carried natively (no prevention-status extension on Immunization by design)

Immunization/prevention-covid-avery-20250408 — claims conformance to Immunization Profile

{
  "resourceType": "Immunization",
  "id": "prevention-covid-avery-20250408",
  "meta": {
    "profile": [
      "../StructureDefinition/nexus-emr-core-immunization"
    ]
  },
  "extension": [
    {
      "url": "../StructureDefinition/nexus-prevention-instructions",
      "valueString": "Remain in the clinic for 15 minutes. Return or call if swelling at the injection site persists past 48 hours."
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p>COVID-19 vaccination administered to Avery Linwood by Dr. Emil Navarro on April 8, 2025 at Cedarbrook Family Health Site A, with post-administration instructions carried on the prevention-instructions extension. Prevention identified by the nexus-emr-prevention-catalog coding; status carried natively (no prevention-status extension needed on Immunization).</p></div>"
  },
  "identifier": [
    {
      "use": "secondary",
      "system": "../NamingSystem/cedarbrook-clinic-immunization-raw-code",
      "value": "EMR-IMM-COVID-AVERY-20250408"
    }
  ],
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "system": "../NamingSystem/nexus-emr-prevention-catalog",
        "code": "covid-19",
        "display": "COVID-19 Vaccination"
      },
      {
        "system": "http://snomed.info/sct",
        "code": "28531000087107",
        "display": "COVID-19 vaccine"
      }
    ],
    "text": "COVID-19 vaccination"
  },
  "patient": {
    "reference": "Patient/avery-linwood",
    "display": "Avery Linwood"
  },
  "encounter": {
    "reference": "Encounter/enc-avery-20250408-01rc",
    "display": "Annual Physical - Cedarbrook Site A"
  },
  "occurrenceDateTime": "2025-04-08",
  "primarySource": true,
  "reportOrigin": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/immunization-origin",
        "code": "provider",
        "display": "Other Provider"
      }
    ],
    "text": "Administered during physical exam"
  },
  "location": {
    "reference": "Location/cedarbrook-site-a",
    "display": "Cedarbrook Family Health - Site A"
  },
  "lotNumber": "COVID-2025-APRIL-BATCH-07",
  "route": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
        "code": "IM",
        "display": "Injection, intramuscular"
      }
    ]
  },
  "site": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "368208006",
        "display": "Left arm"
      }
    ]
  },
  "doseQuantity": {
    "value": 0.3,
    "unit": "mL",
    "system": "http://unitsofmeasure.org",
    "code": "mL"
  },
  "performer": [
    {
      "actor": {
        "reference": "Practitioner/dr-emil-navarro",
        "display": "Dr. Emil Navarro"
      }
    }
  ],
  "note": [
    {
      "authorString": "Dr. Emil Navarro",
      "time": "2025-04-08T10:50:00-06:00",
      "text": "COVID-19 vaccination given as part of routine preventative care. All three Preventions product statuses round-trip from Immunization's native elements (status + primarySource/reportOrigin/statusReason), so Immunization deliberately carries no prevention-status extension. The patient instructions are the nexus-prevention-instructions extension, not a repeat of this element."
    }
  ]
}