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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Summary
Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 21 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Immunization | Immunization event information | |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Reference(ImmunizationRecommendation | MedicationRequest | CarePlan) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder | |
![]() ![]() ![]() | 0..1 | Reference(Medication) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct | |
![]() ![]() ![]() | 0..1 | Reference(Location | BeOrganization) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location | |
![]() ![]() ![]() | 0..1 | code | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus Binding: Vaccination status Value Set (required) | |
![]() ![]() ![]() | 0..1 | Reference(BePatient | BePractitioner | BeOrganization) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | S | 0..* | Identifier | A unique business identifier for a vaccination entry |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description 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. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!SΣ | 1..1 | code | The status of this vaccination record entry Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: Vaccination status reason Value Set (required) |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | The 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. |
![]() ![]() ![]() | SΣ | 1..1 | Reference(BePatient) | The patient that this received vaccination entry refers to |
![]() ![]() ![]() | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
![]() ![]() ![]() | Σ | 1..1 | Vaccine administration date Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() | SΣ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Vaccine administration date |
![]() ![]() ![]() | S | 1..1 | dateTime | The date/time when the vaccination event has been recorded |
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() ![]() | 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. | |
![]() ![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer | |
![]() ![]() ![]() | S | 0..1 | string | Vaccine lot number |
![]() ![]() ![]() | S | 0..1 | date | Vaccine expiration date |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | How vaccine entered body Binding: Vaccine Administration Route (required) |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Amount of vaccine administered | |
![]() ![]() ![]() | SΣ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(BePractitioner | BeOrganization | BePractitionerRole) | Individual or organization who was performing |
![]() ![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Why vaccination has occurred or not (code or text) Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. |
![]() ![]() ![]() | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why vaccination has occurred or not (reference to a finding) |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |
![]() ![]() ![]() | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Educational material document identifier | |
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |
![]() ![]() ![]() | S | 0..* | BackboneElement | Details of a reaction that follows immunization |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | dateTime | When reaction started | |
![]() ![]() ![]() ![]() | 0..1 | Reference(Observation) | Additional information on reaction | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | |
![]() ![]() ![]() | S | 0..* | BackboneElement | Protocol followed by the provider |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Name of vaccine series | |
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |
![]() ![]() ![]() ![]() | 1..1 | Dose number within series Slice: Unordered, Closed by type:$this | ||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Whether this is a first vaccination or a reinforcement |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | The numeric/sequential number of the dose, when adequate |
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Immunization | Immunization event information | |
![]() ![]() ![]() | 0..* | Identifier | A unique business identifier for a vaccination entry | |
![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | The value that is unique |
![]() ![]() ![]() | ?!Σ | 1..1 | code | The status of this vaccination record entry Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() ![]() | 0..1 | CodeableConcept | Reason not done Binding: Vaccination status reason Value Set (required) | |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | The 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. |
![]() ![]() ![]() | Σ | 1..1 | Reference(BePatient) | The patient that this received vaccination entry refers to |
![]() ![]() ![]() | Σ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() | Σ | 0..1 | string | Vaccine administration date |
![]() ![]() ![]() | 1..1 | dateTime | The date/time when the vaccination event has been recorded | |
![]() ![]() ![]() | 0..1 | string | Vaccine lot number | |
![]() ![]() ![]() | 0..1 | date | Vaccine expiration date | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |
![]() ![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: Vaccine Administration Route (required) | |
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() | 0..* | CodeableConcept | Why vaccination has occurred or not (code or text) Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |
![]() ![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why vaccination has occurred or not (reference to a finding) | |
![]() ![]() ![]() | 0..* | BackboneElement | Details of a reaction that follows immunization | |
![]() ![]() ![]() | 0..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() ![]() | 0..1 | string | Whether this is a first vaccination or a reinforcement | |
![]() ![]() ![]() ![]() | 0..1 | positiveInt | The numeric/sequential number of the dose, when adequate | |
![]() |
This structure is derived from Immunization
Summary
Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 21 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Immunization
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Immunization | Immunization event information | |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Reference(ImmunizationRecommendation | MedicationRequest | CarePlan) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder | |
![]() ![]() ![]() | 0..1 | Reference(Medication) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct | |
![]() ![]() ![]() | 0..1 | Reference(Location | BeOrganization) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location | |
![]() ![]() ![]() | 0..1 | code | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus Binding: Vaccination status Value Set (required) | |
![]() ![]() ![]() | 0..1 | Reference(BePatient | BePractitioner | BeOrganization) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | S | 0..* | Identifier | A unique business identifier for a vaccination entry |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description 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. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!SΣ | 1..1 | code | The status of this vaccination record entry Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: Vaccination status reason Value Set (required) |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | The 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. |
![]() ![]() ![]() | SΣ | 1..1 | Reference(BePatient) | The patient that this received vaccination entry refers to |
![]() ![]() ![]() | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
![]() ![]() ![]() | Σ | 1..1 | Vaccine administration date Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() | SΣ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Vaccine administration date |
![]() ![]() ![]() | S | 1..1 | dateTime | The date/time when the vaccination event has been recorded |
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() ![]() | 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. | |
![]() ![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer | |
![]() ![]() ![]() | S | 0..1 | string | Vaccine lot number |
![]() ![]() ![]() | S | 0..1 | date | Vaccine expiration date |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | How vaccine entered body Binding: Vaccine Administration Route (required) |
![]() ![]() ![]() | 0..1 | SimpleQuantity | Amount of vaccine administered | |
![]() ![]() ![]() | SΣ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(BePractitioner | BeOrganization | BePractitionerRole) | Individual or organization who was performing |
![]() ![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Why vaccination has occurred or not (code or text) Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. |
![]() ![]() ![]() | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why vaccination has occurred or not (reference to a finding) |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |
![]() ![]() ![]() | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Educational material document identifier | |
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |
![]() ![]() ![]() | S | 0..* | BackboneElement | Details of a reaction that follows immunization |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | dateTime | When reaction started | |
![]() ![]() ![]() ![]() | 0..1 | Reference(Observation) | Additional information on reaction | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | |
![]() ![]() ![]() | S | 0..* | BackboneElement | Protocol followed by the provider |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Name of vaccine series | |
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |
![]() ![]() ![]() ![]() | 1..1 | Dose number within series Slice: Unordered, Closed by type:$this | ||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Whether this is a first vaccination or a reinforcement |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | The numeric/sequential number of the dose, when adequate |
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Immunization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Immunization.identifier.use | required | IdentifierUse |
Immunization.identifier.type | extensible | Identifier Type Codes |
Immunization.status | required | ImmunizationStatusCodes |
Immunization.statusReason | required | BeVSVaccinationStatusReason |
Immunization.vaccineCode | example | VaccineAdministeredValueSet |
Immunization.reportOrigin | example | ImmunizationOriginCodes |
Immunization.site | example | CodesForImmunizationSiteOfAdministration |
Immunization.route | required | BeVSVaccineAdministrationRoute |
Immunization.performer.function | extensible | ImmunizationFunctionCodes |
Immunization.reasonCode | example | ImmunizationReasonCodes |
Immunization.subpotentReason | example | ImmunizationSubpotentReason |
Immunization.programEligibility | example | ImmunizationProgramEligibility |
Immunization.fundingSource | example | ImmunizationFundingSource |
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
Id | Path | Details | Requirements |
dom-2 | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Immunization.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.extension:vaccination-originalorder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.extension:vaccination-originalorder | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.extension:administeredProduct | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.extension:administeredProduct | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.extension:vaccination-location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.extension:vaccination-location | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.extension:vaccination-confirmationStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.extension:vaccination-confirmationStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.extension:recorder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.extension:recorder | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.occurrence[x]:occurrenceDateTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.occurrence[x]:occurrenceString | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.recorded | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.primarySource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reportOrigin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.manufacturer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.lotNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.expirationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.site | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.route | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.doseQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.performer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.performer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.performer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.performer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.performer.function | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.performer.actor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.isSubpotent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.subpotentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
imm-1 | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() | |
ele-1 | Immunization.education.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.education.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.education.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.education.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.education.documentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education.publicationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education.presentationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.programEligibility | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.fundingSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reaction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reaction.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.reaction.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.reaction.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.reaction.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reaction.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reaction.reported | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.protocolApplied.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.protocolApplied.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.protocolApplied.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.doseNumber[x]:doseNumberString | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |