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.

Salient fields

The profile's synthesized-accessor contract: fields TypedFhir surfaces as first-class typed properties, each computed from the instance by a restricted FHIRPath expression. See Salient Fields for what they are, how they shape LLM contexts, and how to declare them.

Key	Type	Expression	Rendered as	Description
vaccine_code	coded	vaccineCode		Vaccine product with raw code support i
status	code	status		completed | entered-in-error | not-done i
occurrence	dateTime	occurrenceDateTime		When vaccine was administered i
site	coded	site		Body site with raw code support i
route	coded	route		Administration route with raw code support i
dose_quantity	quantity	doseQuantity		Amount of vaccine administered

vaccine_code

Short	Vaccine product with raw code support
Definition	Vaccine product administered or to be administered. REQUIRED: text element for human readability RECOMMENDED: a Canadian vaccine vocabulary where a coded value is available -- the National Vaccine Catalogue (NVC), whose generic-agent, tradename and antigen value sets are published over SNOMED CT CA, or SNOMED CT itself ACCEPTED: CVX on a record imported from a US source, carried as received rather than rewritten OPTIONAL: Raw EMR codes for source system preservation CVX is the US CDC's vaccine vocabulary and is not used in Canada's immunization stack; Ontario, OntarioMD and PHAC all work from NVC or SNOMED CT. A record that already carries a CVX code is still valid here -- this element is unbound, and rewriting a code received from a sending system would lose what that system meant. The text element ensures human readability even when coded values are not recognized.
Comments	Where this code was mapped from a source system's own vocabulary, carry the raw coding alongside the mapped one, flagged userSelected = true. See Carrying the raw code.
Expression	vaccineCode
Type	coded
Prose inherited from	Immunization.vaccineCode

status

Short	completed | entered-in-error | not-done
Definition	Indicates the current status of the immunization event.
Comments	Will generally be 'completed' for administered vaccines.
Expression	status
Type	code
Prose inherited from	Immunization.status

occurrence

Short	When vaccine was administered
Definition	The date/time when the vaccine was administered to the patient.
Comments	This is the administration date, not when the immunization was recorded.
Expression	occurrenceDateTime
Type	dateTime
Prose inherited from	Immunization.occurrence[x]

site

Short	Body site with raw code support
Definition	Body site where vaccine was administered. RECOMMENDED: SNOMED CT or other standard terminology when available OPTIONAL: Raw EMR codes for source system preservation
Comments	Useful for tracking injection site reactions and following protocols.
Expression	site
Type	coded
Prose inherited from	Immunization.site

route

Short	Administration route with raw code support
Definition	The path by which the vaccine product is taken into the body. RECOMMENDED: SNOMED CT or other standard terminology when available OPTIONAL: Raw EMR codes for source system preservation
Comments	The route affects absorption and effectiveness of the vaccine.
Expression	route
Type	coded
Prose inherited from	Immunization.route

dose_quantity

Short	Amount of vaccine administered
Definition	The quantity of vaccine product that was administered.
Expression	doseQuantity
Type	quantity
Prose inherited from	Immunization.doseQuantity