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.
Elements / Key elements
The working view: must-support, required, modifier and sliced elements from the effective (snapshot) definition.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | 0..* | Nexus EMR Immunization Core Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, nexus-note-extension-not-where-native |
||
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| text | S | 0..1 | Narrative | Narrative i Invariants: ele-1 |
| extension:preventionInstructions | 0..1 | Extension(Prevention Instructions Extension) | Instructions given to the patient for this immunization i Invariants: ele-1, ext-1 |
|
| identifier | S | 0..* | Identifier | Business identifier(s) for immunization i Invariants: ele-1 |
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| system | 1..1 | uri | The namespace for the identifier value i Invariants: ele-1 |
|
| value | 1..1 | string | The value that is unique i Invariants: ele-1 |
|
| status | S ?! | 1..1 | code | completed | entered-in-error | not-done i Binding: immunization-status ( required)Invariants: ele-1 |
| statusReason | S | 0..1 | CodeableConcept | Why the dose was not given (with status = not-done) i Binding: immunization-status-reason ( example)Invariants: ele-1 |
| vaccineCode | S | 1..1 | CodeableConcept | Vaccine product with raw code support i Binding: vaccine-code ( example)Invariants: ele-1 |
| text | S | 1..1 | string | The vaccine as written, in human-readable form i Invariants: ele-1 |
| patient | S | 1..1 | Reference(Patient Profile) | Who was immunized i Invariants: ele-1 |
| encounter | S | 0..1 | Reference(Encounter Profile) | Encounter when immunization was given i Invariants: ele-1 |
| occurrence[x] | S | 1..1 | dateTime | When vaccine was administered i Invariants: ele-1 |
| extension:dataAbsentReason | S | 0..1 | Extension(data-absent-reason) | Additional content defined by implementations i Invariants: ele-1, ext-1 |
| lotNumber | S | 0..1 | string | Vaccine lot number Invariants: ele-1 |
| expirationDate | S | 0..1 | date | Vaccine expiration date Invariants: ele-1 |
| site | S | 0..1 | CodeableConcept | Body site with raw code support i Binding: immunization-site ( example)Invariants: ele-1 |
| route | S | 0..1 | CodeableConcept | Administration route with raw code support i Binding: immunization-route ( example)Invariants: ele-1 |
| doseQuantity | S | 0..1 | Quantity(SimpleQuantity) | Amount of vaccine administered Invariants: ele-1 |
| performer | S | 0..* | BackboneElement | Who performed the immunization; repeat for an outside performer i Invariants: ele-1 |
| actor | S | 1..1 | Reference(PractitionerRole Profile | Practitioner Profile) | Individual who administered the vaccine (display-only when outside this system) i Invariants: ele-1 |
| note | S | 0..* | Annotation | Clinical comments on the immunization -- one whole comment per repeat i Invariants: ele-1 |
| isSubpotent | ?! | 0..1 | boolean | Dose potency i Invariants: ele-1 |
| protocolApplied | 0..* | BackboneElement | Protocol followed by the provider Invariants: ele-1 |
|
| doseNumber[x] | 1..1 | positiveInt, string | Dose number within series i Invariants: ele-1 |