Immunization Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-immunization |
|---|---|
| Status | draft · 1.26.0 |
| Base | Immunization (constraint) |
| Source | FSH · JSON |
Nexus EMR profile for Immunization resources, aligned with CA-Core+ and CII requirements. Records details about vaccines administered to a patient.
TypedFhir API / Python
The typed accessor surface Immunization exposes for Immunization — generated from this IG's compiled profile; each typed accessor has a validating raw-FHIR twin (xRaw) where marked. The three ports are parity-enforced.
class Immunization(ClinicalResource) — generated source
| Accessor | Type | Access | Notes |
|---|---|---|---|
| effective_date | FuzzyDate | None |
read-only | The resource's effective date — the first present of this profile's date elements (precedence), normalized to the canonical FuzzyDatetime f… |
| display | str | None |
read-only | The resource's human headline — a coded concept's label, else a title / name, else undefined. |
| status | str | None |
read/write | completed | entered-in-error | not-done |
| status_reason | Concept | None |
read/write · raw twin | Why the dose was not given (with status = not-done) |
| vaccine_code | Concept | None |
read/write · raw twin | Vaccine product with raw code support |
| patient | Reference | None |
read/write · raw twin | Who was immunized |
| encounter | Reference | None |
read/write · raw twin | Encounter when immunization was given |
| report_origin | Concept | None |
read/write · raw twin | Indicates the source of a secondarily reported record |
| lot_number | str | None |
read/write | Vaccine lot number |
| expiration_date | FuzzyDate | None |
read/write | Vaccine expiration date |
| site | Concept | None |
read/write · raw twin | Body site with raw code support |
| route | Concept | None |
read/write · raw twin | Administration route with raw code support |
| dose_quantity | Quantity | None |
read/write · raw twin | Amount of vaccine administered |
| performer | dict[] | None |
read/write | Who performed the immunization; repeat for an outside performer |
| note | Notes |
read/write | Clinical comments on the immunization -- one whole comment per repeat |
| reason_code | Concepts |
read/write · raw twin | Why immunization occurred |
| subpotent_reason | Concepts |
read/write · raw twin | Reason for being subpotent |
| program_eligibility | Concepts |
read/write · raw twin | Patient eligibility for a vaccination program |
| funding_source | Concept | None |
read/write · raw twin | Funding source for the vaccine |