Cross Border Data Exchange IG
1.0.0 - CI Build
Cross Border Data Exchange IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/cross-border-data-exchange/ and changes regularly. See the Directory of published versions
Official URL: http://interopehrate.eu/fhir/StructureDefinition/Immunization-IEHR | Version: 1.0.0 | |||
Draft as of 2024-04-08 | Computable Name: ImmunizationIEHR |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | C | 0..* | Immunization | Immunization event information iehr-1: If the original code could not be translated it must be present |
Provenance | S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
status | S | 1..1 | code | completed | entered-in-error | not-done |
vaccineCode | 1..1 | CodeableConcept | Vaccine product administered Binding: CombinedImmunization - IEHR (required) | |
patient | S | 1..1 | Reference(Patient-IEHR) | Who was immunized |
encounter | 0..1 | Reference(Encounter-IEHR) | Encounter immunization was part of | |
occurrence[x] | 1..1 | Vaccine administration date | ||
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
performer | 1..* | BackboneElement | Who performed event | |
actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |
protocolApplied | ||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.vaccineCode | required | CombinedImmunizationIEHRhttp://interopehrate.eu/fhir/ValueSet/CombinedImmunization-IEHR from this IG | |
Immunization.protocolApplied.targetDisease | preferred | TargetDiseasesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips |
Id | Grade | Path(s) | Details | Requirements |
iehr-1 | error | Immunization | If the original code could not be translated it must be present : (vaccineCode.coding.exists(code = 'OTH') and vaccineCode.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | C | 0..* | Immunization | Immunization event information iehr-1: If the original code could not be translated it must be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
Provenance | S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: CombinedImmunization - IEHR (required) |
patient | SΣ | 1..1 | Reference(Patient-IEHR) | Who was immunized |
encounter | 0..1 | Reference(Encounter-IEHR) | Encounter immunization was part of | |
occurrence[x] | Σ | 1..1 | Vaccine administration date | |
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
performer | Σ | 1..* | BackboneElement | Who performed event |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |
Immunization.vaccineCode | required | CombinedImmunizationIEHRhttp://interopehrate.eu/fhir/ValueSet/CombinedImmunization-IEHR from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
iehr-1 | error | Immunization | If the original code could not be translated it must be present : (vaccineCode.coding.exists(code = 'OTH') and vaccineCode.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | C | 0..* | Immunization | Immunization event information iehr-1: If the original code could not be translated it must be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Provenance | S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Business identifier | |||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: CombinedImmunization - IEHR (required) | ||||
patient | SΣ | 1..1 | Reference(Patient-IEHR) | Who was immunized | ||||
encounter | 0..1 | Reference(Encounter-IEHR) | Encounter immunization was part of | |||||
occurrence[x] | Σ | 1..1 | Vaccine administration date | |||||
occurrenceDateTime | dateTime | |||||||
occurrenceString | string | |||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
lotNumber | 0..1 | string | Vaccine lot number | |||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
performer | Σ | 1..* | BackboneElement | Who performed event | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
documentType | 0..1 | string | Educational material document identifier | |||||
reference | 0..1 | uri | Educational material reference pointer | |||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 0..1 | dateTime | When reaction started | |||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
series | 0..1 | string | Name of vaccine series | |||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred) | |||||
doseNumber[x] | 1..1 | Dose number within series | ||||||
doseNumberPositiveInt | positiveInt | |||||||
doseNumberString | string | |||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | required | CombinedImmunizationIEHRhttp://interopehrate.eu/fhir/ValueSet/CombinedImmunization-IEHR from this IG | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard | ||||
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | preferred | TargetDiseasesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
iehr-1 | error | Immunization | If the original code could not be translated it must be present : (vaccineCode.coding.exists(code = 'OTH') and vaccineCode.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not() | |
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Summary
Mandatory: 5 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | C | 0..* | Immunization | Immunization event information iehr-1: If the original code could not be translated it must be present |
Provenance | S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
status | S | 1..1 | code | completed | entered-in-error | not-done |
vaccineCode | 1..1 | CodeableConcept | Vaccine product administered Binding: CombinedImmunization - IEHR (required) | |
patient | S | 1..1 | Reference(Patient-IEHR) | Who was immunized |
encounter | 0..1 | Reference(Encounter-IEHR) | Encounter immunization was part of | |
occurrence[x] | 1..1 | Vaccine administration date | ||
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
performer | 1..* | BackboneElement | Who performed event | |
actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |
protocolApplied | ||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.vaccineCode | required | CombinedImmunizationIEHRhttp://interopehrate.eu/fhir/ValueSet/CombinedImmunization-IEHR from this IG | |
Immunization.protocolApplied.targetDisease | preferred | TargetDiseasesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips |
Id | Grade | Path(s) | Details | Requirements |
iehr-1 | error | Immunization | If the original code could not be translated it must be present : (vaccineCode.coding.exists(code = 'OTH') and vaccineCode.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | C | 0..* | Immunization | Immunization event information iehr-1: If the original code could not be translated it must be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
Provenance | S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: CombinedImmunization - IEHR (required) |
patient | SΣ | 1..1 | Reference(Patient-IEHR) | Who was immunized |
encounter | 0..1 | Reference(Encounter-IEHR) | Encounter immunization was part of | |
occurrence[x] | Σ | 1..1 | Vaccine administration date | |
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
performer | Σ | 1..* | BackboneElement | Who performed event |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |
Immunization.vaccineCode | required | CombinedImmunizationIEHRhttp://interopehrate.eu/fhir/ValueSet/CombinedImmunization-IEHR from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
iehr-1 | error | Immunization | If the original code could not be translated it must be present : (vaccineCode.coding.exists(code = 'OTH') and vaccineCode.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | C | 0..* | Immunization | Immunization event information iehr-1: If the original code could not be translated it must be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Provenance | S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Business identifier | |||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: CombinedImmunization - IEHR (required) | ||||
patient | SΣ | 1..1 | Reference(Patient-IEHR) | Who was immunized | ||||
encounter | 0..1 | Reference(Encounter-IEHR) | Encounter immunization was part of | |||||
occurrence[x] | Σ | 1..1 | Vaccine administration date | |||||
occurrenceDateTime | dateTime | |||||||
occurrenceString | string | |||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
lotNumber | 0..1 | string | Vaccine lot number | |||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
performer | Σ | 1..* | BackboneElement | Who performed event | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
documentType | 0..1 | string | Educational material document identifier | |||||
reference | 0..1 | uri | Educational material reference pointer | |||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 0..1 | dateTime | When reaction started | |||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
series | 0..1 | string | Name of vaccine series | |||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred) | |||||
doseNumber[x] | 1..1 | Dose number within series | ||||||
doseNumberPositiveInt | positiveInt | |||||||
doseNumberString | string | |||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | required | CombinedImmunizationIEHRhttp://interopehrate.eu/fhir/ValueSet/CombinedImmunization-IEHR from this IG | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard | ||||
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | preferred | TargetDiseasesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
iehr-1 | error | Immunization | If the original code could not be translated it must be present : (vaccineCode.coding.exists(code = 'OTH') and vaccineCode.coding.all(extension.exists(url = 'http://interopehrate.eu/fhir/StructureDefinition/AutomaticallyGenerated-Extension-IEHR' and value = 'true'))).not() | |
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Summary
Mandatory: 5 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron