Belgium eHealth FHIR Core specifications
1.2.2 - CI Build

This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: BeVaccination

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-vaccination
Version:1.2.2
Name:BeVaccination
Status:Active as of 2021-01-10T10:59:49+00:00
Definition:

Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.

Publisher:eHealth
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-vaccination

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder
... be-ext-administeredProduct 0..1Reference(Medication)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct
... be-ext-vaccination-confirmationStatus 0..1codeExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: Vaccination status Value Set (required)
... be-ext-recorder 0..1Reference(BePatient | BePractitioner | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeThe status of this vaccination record entry
... statusReason S0..1CodeableConceptReason not done
Binding: Vaccination status reason Value Set (required)
... vaccineCode S1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... patient S1..1Reference(BePatient)The patient that this received vaccination entry refers to
... occurrenceDateTime S0..1dateTimeVaccine administration date
... occurrenceString S0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... location 0..0
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
... route S0..1CodeableConceptHow vaccine entered body
Binding: Vaccine Administration Route (required)
... performer S0..*BackboneElementWho performed event
.... actor 1..1Reference(BePractitioner | BeOrganization | BePractitionerRole)Individual or organization who was performing
... reasonCode S0..*CodeableConceptWhy vaccination has occurred or not (code or text)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... doseNumberString S0..1stringWhether this is a first vaccination or a reinforcement
.... doseNumberPositiveInt S0..1positiveIntThe numeric/sequential number of the dose, when adequate

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder
... be-ext-administeredProduct 0..1Reference(Medication)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct
... be-ext-vaccination-location 0..1Reference(Location | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location
... be-ext-vaccination-confirmationStatus 0..1codeExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: Vaccination status Value Set (required)
... be-ext-recorder 0..1Reference(BePatient | BePractitioner | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeThe status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: Vaccination status reason Value Set (required)
... vaccineCode SΣ1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

... patient SΣ1..1Reference(BePatient)The patient that this received vaccination entry refers to
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣ0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣ0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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.

... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route S0..1CodeableConceptHow vaccine entered body
Binding: Vaccine Administration Route (required)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(BePractitioner | BeOrganization | BePractitionerRole)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy vaccination has occurred or not (code or text)
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumberStringstring
..... doseNumberPositiveIntpositiveInt
..... doseNumber[x]:doseNumberString S0..1stringWhether this is a first vaccination or a reinforcement
..... doseNumber[x]:doseNumberPositiveInt S0..1positiveIntThe numeric/sequential number of the dose, when adequate
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... identifier 0..*IdentifierA unique business identifier for a vaccination entry
.... system Σ1..1uriThe namespace for the identifier value
.... value Σ1..1stringThe value that is unique
... status ?!Σ1..1codeThe status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1CodeableConceptReason not done
Binding: Vaccination status reason Value Set (required)
... patient Σ1..1Reference(BePatient)The patient that this received vaccination entry refers to
... occurrence[x]:occurrenceDateTime Σ0..1dateTimeVaccine administration date
... occurrence[x]:occurrenceString Σ0..1stringVaccine administration date
... recorded 1..1dateTimeThe date/time when the vaccination event has been recorded
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route 0..1CodeableConceptHow vaccine entered body
Binding: Vaccine Administration Route (required)
... performer Σ0..*BackboneElementWho performed event
... reasonCode 0..*CodeableConceptWhy vaccination has occurred or not (code or text)
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... reaction 0..*BackboneElementDetails of a reaction that follows immunization
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... doseNumber[x]:doseNumberString 0..1stringWhether this is a first vaccination or a reinforcement
.... doseNumber[x]:doseNumberPositiveInt 0..1positiveIntThe numeric/sequential number of the dose, when adequate

doco Documentation for this format

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder
... be-ext-administeredProduct 0..1Reference(Medication)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct
... be-ext-vaccination-confirmationStatus 0..1codeExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: Vaccination status Value Set (required)
... be-ext-recorder 0..1Reference(BePatient | BePractitioner | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeThe status of this vaccination record entry
... statusReason S0..1CodeableConceptReason not done
Binding: Vaccination status reason Value Set (required)
... vaccineCode S1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... patient S1..1Reference(BePatient)The patient that this received vaccination entry refers to
... occurrenceDateTime S0..1dateTimeVaccine administration date
... occurrenceString S0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... location 0..0
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
... route S0..1CodeableConceptHow vaccine entered body
Binding: Vaccine Administration Route (required)
... performer S0..*BackboneElementWho performed event
.... actor 1..1Reference(BePractitioner | BeOrganization | BePractitionerRole)Individual or organization who was performing
... reasonCode S0..*CodeableConceptWhy vaccination has occurred or not (code or text)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... doseNumberString S0..1stringWhether this is a first vaccination or a reinforcement
.... doseNumberPositiveInt S0..1positiveIntThe numeric/sequential number of the dose, when adequate

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... be-ext-vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder
... be-ext-administeredProduct 0..1Reference(Medication)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct
... be-ext-vaccination-location 0..1Reference(Location | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location
... be-ext-vaccination-confirmationStatus 0..1codeExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: Vaccination status Value Set (required)
... be-ext-recorder 0..1Reference(BePatient | BePractitioner | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeThe status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: Vaccination status reason Value Set (required)
... vaccineCode SΣ1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

... patient SΣ1..1Reference(BePatient)The patient that this received vaccination entry refers to
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣ0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣ0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates 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.

... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route S0..1CodeableConceptHow vaccine entered body
Binding: Vaccine Administration Route (required)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(BePractitioner | BeOrganization | BePractitionerRole)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptWhy vaccination has occurred or not (code or text)
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... Slices for doseNumber[x] 1..1Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumberStringstring
..... doseNumberPositiveIntpositiveInt
..... doseNumber[x]:doseNumberString S0..1stringWhether this is a first vaccination or a reinforcement
..... doseNumber[x]:doseNumberPositiveInt S0..1positiveIntThe numeric/sequential number of the dose, when adequate
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.identifier.userequiredIdentifierUse
Immunization.identifier.typeextensibleIdentifier Type Codes
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routerequiredBeVSVaccineAdministrationRoute
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

IdPathDetailsRequirements
dom-2ImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ImmunizationIf 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-4ImmunizationIf 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-5ImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Immunization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:vaccination-originalorderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extension:vaccination-originalorderMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:administeredProductAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extension:administeredProductMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:vaccination-locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extension:vaccination-locationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:vaccination-confirmationStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extension:vaccination-confirmationStatusMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:recorderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extension:recorderMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.occurrence[x]:occurrenceDateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.occurrence[x]:occurrenceStringAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.recordedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.primarySourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reportOriginAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.siteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.routeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.doseQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.performer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.performer.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.performer.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.performer.functionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.isSubpotentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.subpotentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.educationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imm-1Immunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
ele-1Immunization.education.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.education.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.education.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.education.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.education.documentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.publicationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.presentationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.programEligibilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.fundingSourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reactionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.reaction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.reaction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.reaction.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.reportedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolAppliedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.protocolApplied.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.protocolApplied.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.protocolApplied.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.protocolApplied.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.doseNumber[x]:doseNumberStringAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveIntAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())