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 / Snapshot
The full effective definition: base Immunization with this profile's constraints applied.
| 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 |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| versionId | 0..1 | id | Version specific identifier i Invariants: ele-1 |
|
| lastUpdated | 0..1 | instant | When the resource version last changed i Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| profile | 0..* | canonical | Profiles this resource claims to conform to i Invariants: ele-1 |
|
| security | 0..* | Coding | Security Labels applied to this resource i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| tag | 0..* | Coding | Tags applied to this resource i Binding: common-tags ( example)Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | S | 0..1 | Narrative | Narrative i Invariants: ele-1 |
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:preventionInstructions | 0..1 | Extension(Prevention Instructions Extension) | Instructions given to the patient for this immunization i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| identifier | S | 0..* | Identifier | Business identifier(s) for immunization i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| type | 0..1 | CodeableConcept | Description of identifier i Binding: identifier-type ( extensible)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 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) 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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 0..* | Coding | Code defined by a terminology system i 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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:dataAbsentReason | S | 0..1 | Extension(data-absent-reason) | Additional content defined by implementations i Invariants: ele-1, ext-1 |
| value | 0..1 | http://hl7.org/fhirpath/System.DateTime | Primitive value for dateTime | |
| recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record Invariants: ele-1 |
|
| primarySource | 0..1 | boolean | Indicates context the data was recorded in i Invariants: ele-1 |
|
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record i Binding: immunization-origin ( example)Invariants: ele-1 |
|
| location | 0..1 | Reference(Location) | Where immunization occurred Invariants: ele-1 |
|
| manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer Invariants: ele-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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| function | 0..1 | CodeableConcept | What type of performance was done Binding: immunization-function ( extensible)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 |
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: immunization-reason ( example)Invariants: ele-1 |
|
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred Invariants: ele-1 |
|
| isSubpotent | ?! | 0..1 | boolean | Dose potency i Invariants: ele-1 |
| subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: immunization-subpotent-reason ( example)Invariants: ele-1 |
|
| education | 0..* | BackboneElement | Educational material presented to patient Invariants: ele-1, imm-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| documentType | 0..1 | string | Educational material document identifier Invariants: ele-1 |
|
| reference | 0..1 | uri | Educational material reference pointer Invariants: ele-1 |
|
| publicationDate | 0..1 | dateTime | Educational material publication date Invariants: ele-1 |
|
| presentationDate | 0..1 | dateTime | Educational material presentation date Invariants: ele-1 |
|
| programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: immunization-program-eligibility ( example)Invariants: ele-1 |
|
| fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: immunization-funding-source ( example)Invariants: ele-1 |
|
| reaction | 0..* | BackboneElement | Details of a reaction that follows immunization i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| date | 0..1 | dateTime | When reaction started Invariants: ele-1 |
|
| detail | 0..1 | Reference(Observation) | Additional information on reaction Invariants: ele-1 |
|
| reported | 0..1 | boolean | Indicates self-reported reaction Invariants: ele-1 |
|
| protocolApplied | 0..* | BackboneElement | Protocol followed by the provider Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| series | 0..1 | string | Name of vaccine series Invariants: ele-1 |
|
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations Invariants: ele-1 |
|
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: immunization-target-disease ( example)Invariants: ele-1 |
|
| doseNumber[x] | 1..1 | positiveInt, string | Dose number within series i Invariants: ele-1 |
|
| seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity i Invariants: ele-1 |