Cumuluz Translate Implementation Guide
0.1.0 - ci-build
Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-immunization | Version: 0.1.0 | |||
| Draft as of 2026-07-11 | Computable Name: LogicalImmunization | |||
Canonical intermediate logical model for Immunization-shaped nl-core routes.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Element | Logical Model: Immunization Elementen gedefinieerd in ancestors:@id, extension Constraints: logical-immunization-occurrence-choice |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url | |
![]() ![]() |
0..1 | uri | source Profile | |
![]() ![]() |
0..1 | uri | target Profile | |
![]() ![]() |
0..1 | code | FHIR source resource type accepted on the source side. | |
![]() ![]() |
0..1 | code | FHIR target resource type produced on the target side. | |
![]() ![]() |
0..* | Identifier | Immunization identifiers. | |
![]() ![]() |
0..1 | code | Immunization status. | |
![]() ![]() |
0..1 | CodeableConcept | Status reason. | |
![]() ![]() |
0..1 | boolean | Whether the administered vaccine was subpotent. | |
![]() ![]() |
0..* | CodeableConcept | Reasons why the administered vaccine was subpotent. | |
![]() ![]() |
0..1 | Reference() | Vaccination pharmaceutical product. | |
![]() ![]() |
0..1 | CodeableConcept | Vaccine code. | |
![]() ![]() |
0..1 | Reference() | Patient. | |
![]() ![]() |
0..1 | Reference() | Encounter. | |
![]() ![]() |
0..1 | |||
![]() ![]() ![]() |
0..1 | dateTime | Occurrence dateTime. | |
![]() ![]() ![]() |
0..1 | string | Occurrence string. | |
![]() ![]() |
0..1 | dateTime | Recorded time. | |
![]() ![]() |
0..1 | boolean | Primary source. | |
![]() ![]() |
0..1 | CodeableConcept | Report origin. | |
![]() ![]() |
0..1 | Reference() | Location. | |
![]() ![]() |
0..1 | Reference() | Manufacturer. | |
![]() ![]() |
0..1 | string | Lot number. | |
![]() ![]() |
0..1 | date | Expiration date. | |
![]() ![]() |
0..1 | CodeableConcept | Site. | |
![]() ![]() |
0..1 | CodeableConcept | Route. | |
![]() ![]() |
0..1 | Quantity | Dose quantity. | |
![]() ![]() |
0..* | Reference() | Performer actors. | |
![]() ![]() |
0..* | CodeableConcept | Reason codes. | |
![]() ![]() |
0..* | Reference() | Reason references. | |
![]() ![]() |
0..* | logical-immunization-education | Educational material presented for the immunization. | |
![]() ![]() |
0..* | CodeableConcept | Eligibility for an immunization program. | |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine. | |
![]() ![]() |
0..* | logical-immunization-reaction | Observed reactions following immunization. | |
![]() ![]() |
0..* | CodeableConcept | Protocol target diseases. | |
![]() ![]() |
0..1 | string | Protocol dose number as string. | |
![]() ![]() |
0..1 | positiveInt | Protocol dose number as positive integer. | |
![]() ![]() |
0..* | Annotation | Notes. | |
Documentatie voor dit formaat | ||||
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| logical-immunization-occurrence-choice | error | logical-immunization | Only one immunization occurrence value may be present. |
(occurrenceDateTime | occurrenceString).count() <= 1
|
This structure is derived from Element
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Element | Logical Model: Immunization Elementen gedefinieerd in ancestors:@id, extension Constraints: logical-immunization-occurrence-choice |
![]() ![]() |
0..1 | uri | source Profile | |
![]() ![]() |
0..1 | uri | target Profile | |
![]() ![]() |
0..1 | code | FHIR source resource type accepted on the source side. | |
![]() ![]() |
0..1 | code | FHIR target resource type produced on the target side. | |
![]() ![]() |
0..* | Identifier | Immunization identifiers. | |
![]() ![]() |
0..1 | code | Immunization status. | |
![]() ![]() |
0..1 | CodeableConcept | Status reason. | |
![]() ![]() |
0..1 | boolean | Whether the administered vaccine was subpotent. | |
![]() ![]() |
0..* | CodeableConcept | Reasons why the administered vaccine was subpotent. | |
![]() ![]() |
0..1 | Reference() | Vaccination pharmaceutical product. | |
![]() ![]() |
0..1 | CodeableConcept | Vaccine code. | |
![]() ![]() |
0..1 | Reference() | Patient. | |
![]() ![]() |
0..1 | Reference() | Encounter. | |
![]() ![]() |
0..1 | |||
![]() ![]() ![]() |
0..1 | dateTime | Occurrence dateTime. | |
![]() ![]() ![]() |
0..1 | string | Occurrence string. | |
![]() ![]() |
0..1 | dateTime | Recorded time. | |
![]() ![]() |
0..1 | boolean | Primary source. | |
![]() ![]() |
0..1 | CodeableConcept | Report origin. | |
![]() ![]() |
0..1 | Reference() | Location. | |
![]() ![]() |
0..1 | Reference() | Manufacturer. | |
![]() ![]() |
0..1 | string | Lot number. | |
![]() ![]() |
0..1 | date | Expiration date. | |
![]() ![]() |
0..1 | CodeableConcept | Site. | |
![]() ![]() |
0..1 | CodeableConcept | Route. | |
![]() ![]() |
0..1 | Quantity | Dose quantity. | |
![]() ![]() |
0..* | Reference() | Performer actors. | |
![]() ![]() |
0..* | CodeableConcept | Reason codes. | |
![]() ![]() |
0..* | Reference() | Reason references. | |
![]() ![]() |
0..* | logical-immunization-education | Educational material presented for the immunization. | |
![]() ![]() |
0..* | CodeableConcept | Eligibility for an immunization program. | |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine. | |
![]() ![]() |
0..* | logical-immunization-reaction | Observed reactions following immunization. | |
![]() ![]() |
0..* | CodeableConcept | Protocol target diseases. | |
![]() ![]() |
0..1 | string | Protocol dose number as string. | |
![]() ![]() |
0..1 | positiveInt | Protocol dose number as positive integer. | |
![]() ![]() |
0..* | Annotation | Notes. | |
Documentatie voor dit formaat | ||||
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| logical-immunization-occurrence-choice | error | logical-immunization | Only one immunization occurrence value may be present. |
(occurrenceDateTime | occurrenceString).count() <= 1
|
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Element | Logical Model: Immunization Elementen gedefinieerd in ancestors:@id, extension Constraints: logical-immunization-occurrence-choice |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url | |
![]() ![]() |
0..1 | uri | source Profile | |
![]() ![]() |
0..1 | uri | target Profile | |
![]() ![]() |
0..1 | code | FHIR source resource type accepted on the source side. | |
![]() ![]() |
0..1 | code | FHIR target resource type produced on the target side. | |
![]() ![]() |
0..* | Identifier | Immunization identifiers. | |
![]() ![]() |
0..1 | code | Immunization status. | |
![]() ![]() |
0..1 | CodeableConcept | Status reason. | |
![]() ![]() |
0..1 | boolean | Whether the administered vaccine was subpotent. | |
![]() ![]() |
0..* | CodeableConcept | Reasons why the administered vaccine was subpotent. | |
![]() ![]() |
0..1 | Reference() | Vaccination pharmaceutical product. | |
![]() ![]() |
0..1 | CodeableConcept | Vaccine code. | |
![]() ![]() |
0..1 | Reference() | Patient. | |
![]() ![]() |
0..1 | Reference() | Encounter. | |
![]() ![]() |
0..1 | |||
![]() ![]() ![]() |
0..1 | dateTime | Occurrence dateTime. | |
![]() ![]() ![]() |
0..1 | string | Occurrence string. | |
![]() ![]() |
0..1 | dateTime | Recorded time. | |
![]() ![]() |
0..1 | boolean | Primary source. | |
![]() ![]() |
0..1 | CodeableConcept | Report origin. | |
![]() ![]() |
0..1 | Reference() | Location. | |
![]() ![]() |
0..1 | Reference() | Manufacturer. | |
![]() ![]() |
0..1 | string | Lot number. | |
![]() ![]() |
0..1 | date | Expiration date. | |
![]() ![]() |
0..1 | CodeableConcept | Site. | |
![]() ![]() |
0..1 | CodeableConcept | Route. | |
![]() ![]() |
0..1 | Quantity | Dose quantity. | |
![]() ![]() |
0..* | Reference() | Performer actors. | |
![]() ![]() |
0..* | CodeableConcept | Reason codes. | |
![]() ![]() |
0..* | Reference() | Reason references. | |
![]() ![]() |
0..* | logical-immunization-education | Educational material presented for the immunization. | |
![]() ![]() |
0..* | CodeableConcept | Eligibility for an immunization program. | |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine. | |
![]() ![]() |
0..* | logical-immunization-reaction | Observed reactions following immunization. | |
![]() ![]() |
0..* | CodeableConcept | Protocol target diseases. | |
![]() ![]() |
0..1 | string | Protocol dose number as string. | |
![]() ![]() |
0..1 | positiveInt | Protocol dose number as positive integer. | |
![]() ![]() |
0..* | Annotation | Notes. | |
Documentatie voor dit formaat | ||||
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| logical-immunization-occurrence-choice | error | logical-immunization | Only one immunization occurrence value may be present. |
(occurrenceDateTime | occurrenceString).count() <= 1
|
This structure is derived from Element
Key Elements View
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Element | Logical Model: Immunization Elementen gedefinieerd in ancestors:@id, extension Constraints: logical-immunization-occurrence-choice |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url | |
![]() ![]() |
0..1 | uri | source Profile | |
![]() ![]() |
0..1 | uri | target Profile | |
![]() ![]() |
0..1 | code | FHIR source resource type accepted on the source side. | |
![]() ![]() |
0..1 | code | FHIR target resource type produced on the target side. | |
![]() ![]() |
0..* | Identifier | Immunization identifiers. | |
![]() ![]() |
0..1 | code | Immunization status. | |
![]() ![]() |
0..1 | CodeableConcept | Status reason. | |
![]() ![]() |
0..1 | boolean | Whether the administered vaccine was subpotent. | |
![]() ![]() |
0..* | CodeableConcept | Reasons why the administered vaccine was subpotent. | |
![]() ![]() |
0..1 | Reference() | Vaccination pharmaceutical product. | |
![]() ![]() |
0..1 | CodeableConcept | Vaccine code. | |
![]() ![]() |
0..1 | Reference() | Patient. | |
![]() ![]() |
0..1 | Reference() | Encounter. | |
![]() ![]() |
0..1 | |||
![]() ![]() ![]() |
0..1 | dateTime | Occurrence dateTime. | |
![]() ![]() ![]() |
0..1 | string | Occurrence string. | |
![]() ![]() |
0..1 | dateTime | Recorded time. | |
![]() ![]() |
0..1 | boolean | Primary source. | |
![]() ![]() |
0..1 | CodeableConcept | Report origin. | |
![]() ![]() |
0..1 | Reference() | Location. | |
![]() ![]() |
0..1 | Reference() | Manufacturer. | |
![]() ![]() |
0..1 | string | Lot number. | |
![]() ![]() |
0..1 | date | Expiration date. | |
![]() ![]() |
0..1 | CodeableConcept | Site. | |
![]() ![]() |
0..1 | CodeableConcept | Route. | |
![]() ![]() |
0..1 | Quantity | Dose quantity. | |
![]() ![]() |
0..* | Reference() | Performer actors. | |
![]() ![]() |
0..* | CodeableConcept | Reason codes. | |
![]() ![]() |
0..* | Reference() | Reason references. | |
![]() ![]() |
0..* | logical-immunization-education | Educational material presented for the immunization. | |
![]() ![]() |
0..* | CodeableConcept | Eligibility for an immunization program. | |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine. | |
![]() ![]() |
0..* | logical-immunization-reaction | Observed reactions following immunization. | |
![]() ![]() |
0..* | CodeableConcept | Protocol target diseases. | |
![]() ![]() |
0..1 | string | Protocol dose number as string. | |
![]() ![]() |
0..1 | positiveInt | Protocol dose number as positive integer. | |
![]() ![]() |
0..* | Annotation | Notes. | |
Documentatie voor dit formaat | ||||
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| logical-immunization-occurrence-choice | error | logical-immunization | Only one immunization occurrence value may be present. |
(occurrenceDateTime | occurrenceString).count() <= 1
|
Differential View
This structure is derived from Element
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Element | Logical Model: Immunization Elementen gedefinieerd in ancestors:@id, extension Constraints: logical-immunization-occurrence-choice |
![]() ![]() |
0..1 | uri | source Profile | |
![]() ![]() |
0..1 | uri | target Profile | |
![]() ![]() |
0..1 | code | FHIR source resource type accepted on the source side. | |
![]() ![]() |
0..1 | code | FHIR target resource type produced on the target side. | |
![]() ![]() |
0..* | Identifier | Immunization identifiers. | |
![]() ![]() |
0..1 | code | Immunization status. | |
![]() ![]() |
0..1 | CodeableConcept | Status reason. | |
![]() ![]() |
0..1 | boolean | Whether the administered vaccine was subpotent. | |
![]() ![]() |
0..* | CodeableConcept | Reasons why the administered vaccine was subpotent. | |
![]() ![]() |
0..1 | Reference() | Vaccination pharmaceutical product. | |
![]() ![]() |
0..1 | CodeableConcept | Vaccine code. | |
![]() ![]() |
0..1 | Reference() | Patient. | |
![]() ![]() |
0..1 | Reference() | Encounter. | |
![]() ![]() |
0..1 | |||
![]() ![]() ![]() |
0..1 | dateTime | Occurrence dateTime. | |
![]() ![]() ![]() |
0..1 | string | Occurrence string. | |
![]() ![]() |
0..1 | dateTime | Recorded time. | |
![]() ![]() |
0..1 | boolean | Primary source. | |
![]() ![]() |
0..1 | CodeableConcept | Report origin. | |
![]() ![]() |
0..1 | Reference() | Location. | |
![]() ![]() |
0..1 | Reference() | Manufacturer. | |
![]() ![]() |
0..1 | string | Lot number. | |
![]() ![]() |
0..1 | date | Expiration date. | |
![]() ![]() |
0..1 | CodeableConcept | Site. | |
![]() ![]() |
0..1 | CodeableConcept | Route. | |
![]() ![]() |
0..1 | Quantity | Dose quantity. | |
![]() ![]() |
0..* | Reference() | Performer actors. | |
![]() ![]() |
0..* | CodeableConcept | Reason codes. | |
![]() ![]() |
0..* | Reference() | Reason references. | |
![]() ![]() |
0..* | logical-immunization-education | Educational material presented for the immunization. | |
![]() ![]() |
0..* | CodeableConcept | Eligibility for an immunization program. | |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine. | |
![]() ![]() |
0..* | logical-immunization-reaction | Observed reactions following immunization. | |
![]() ![]() |
0..* | CodeableConcept | Protocol target diseases. | |
![]() ![]() |
0..1 | string | Protocol dose number as string. | |
![]() ![]() |
0..1 | positiveInt | Protocol dose number as positive integer. | |
![]() ![]() |
0..* | Annotation | Notes. | |
Documentatie voor dit formaat | ||||
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| logical-immunization-occurrence-choice | error | logical-immunization | Only one immunization occurrence value may be present. |
(occurrenceDateTime | occurrenceString).count() <= 1
|
Snapshot View
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Element | Logical Model: Immunization Elementen gedefinieerd in ancestors:@id, extension Constraints: logical-immunization-occurrence-choice |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Zonder volgorde, Open op value:url | |
![]() ![]() |
0..1 | uri | source Profile | |
![]() ![]() |
0..1 | uri | target Profile | |
![]() ![]() |
0..1 | code | FHIR source resource type accepted on the source side. | |
![]() ![]() |
0..1 | code | FHIR target resource type produced on the target side. | |
![]() ![]() |
0..* | Identifier | Immunization identifiers. | |
![]() ![]() |
0..1 | code | Immunization status. | |
![]() ![]() |
0..1 | CodeableConcept | Status reason. | |
![]() ![]() |
0..1 | boolean | Whether the administered vaccine was subpotent. | |
![]() ![]() |
0..* | CodeableConcept | Reasons why the administered vaccine was subpotent. | |
![]() ![]() |
0..1 | Reference() | Vaccination pharmaceutical product. | |
![]() ![]() |
0..1 | CodeableConcept | Vaccine code. | |
![]() ![]() |
0..1 | Reference() | Patient. | |
![]() ![]() |
0..1 | Reference() | Encounter. | |
![]() ![]() |
0..1 | |||
![]() ![]() ![]() |
0..1 | dateTime | Occurrence dateTime. | |
![]() ![]() ![]() |
0..1 | string | Occurrence string. | |
![]() ![]() |
0..1 | dateTime | Recorded time. | |
![]() ![]() |
0..1 | boolean | Primary source. | |
![]() ![]() |
0..1 | CodeableConcept | Report origin. | |
![]() ![]() |
0..1 | Reference() | Location. | |
![]() ![]() |
0..1 | Reference() | Manufacturer. | |
![]() ![]() |
0..1 | string | Lot number. | |
![]() ![]() |
0..1 | date | Expiration date. | |
![]() ![]() |
0..1 | CodeableConcept | Site. | |
![]() ![]() |
0..1 | CodeableConcept | Route. | |
![]() ![]() |
0..1 | Quantity | Dose quantity. | |
![]() ![]() |
0..* | Reference() | Performer actors. | |
![]() ![]() |
0..* | CodeableConcept | Reason codes. | |
![]() ![]() |
0..* | Reference() | Reason references. | |
![]() ![]() |
0..* | logical-immunization-education | Educational material presented for the immunization. | |
![]() ![]() |
0..* | CodeableConcept | Eligibility for an immunization program. | |
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine. | |
![]() ![]() |
0..* | logical-immunization-reaction | Observed reactions following immunization. | |
![]() ![]() |
0..* | CodeableConcept | Protocol target diseases. | |
![]() ![]() |
0..1 | string | Protocol dose number as string. | |
![]() ![]() |
0..1 | positiveInt | Protocol dose number as positive integer. | |
![]() ![]() |
0..* | Annotation | Notes. | |
Documentatie voor dit formaat | ||||
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| logical-immunization-occurrence-choice | error | logical-immunization | Only one immunization occurrence value may be present. |
(occurrenceDateTime | occurrenceString).count() <= 1
|
This structure is derived from Element