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.

TypedFhir API / TypeScript

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 extends ClinicalResourcegenerated source

Accessor Type Access Notes
$effectiveDate FuzzyDate | undefined read-only The resource's effective date — the first present of this profile's date elements (precedence), normalized to the canonical FuzzyDatetime f…
$display string | undefined read-only The resource's human headline — a coded concept's label, else a title / name, else undefined.
status string | undefined read/write completed | entered-in-error | not-done
statusReason Concept | undefined read/write · raw twin Why the dose was not given (with status = not-done)
vaccineCode Concept | undefined read/write · raw twin Vaccine product with raw code support
patient Reference | undefined read/write · raw twin Who was immunized
encounter Reference | undefined read/write · raw twin Encounter when immunization was given
reportOrigin Concept | undefined read/write · raw twin Indicates the source of a secondarily reported record
lotNumber string | undefined read/write Vaccine lot number
expirationDate FuzzyDate | undefined read/write Vaccine expiration date
site Concept | undefined read/write · raw twin Body site with raw code support
route Concept | undefined read/write · raw twin Administration route with raw code support
doseQuantity Quantity | undefined read/write · raw twin Amount of vaccine administered
performer Json[] | undefined 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
reasonCode Concepts read/write · raw twin Why immunization occurred
subpotentReason Concepts read/write · raw twin Reason for being subpotent
programEligibility Concepts read/write · raw twin Patient eligibility for a vaccination program
fundingSource Concept | undefined read/write · raw twin Funding source for the vaccine