Left: | BeVaccination (https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination) |
Right: | BeVaccination (https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination) |
Error | StructureDefinition.version | Values for version differ: '1.0.1' vs '1.0.2' |
Information | StructureDefinition.date | Values for date differ: '2022-10-19T09:29:07+02:00' vs '2023-02-16T14:12:15+01:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Immunization | ||
copyright | |||
date | 2022-10-19T09:29:07+02:00 | 2023-02-16T14:12:15+01:00 |
|
description | Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#BE | ||
kind | resource | ||
name | BeVaccination | ||
publisher | eHealth Platform | ||
purpose | |||
status | active | ||
title | BeVaccination | ||
type | Immunization | ||
url | https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination | ||
version | 1.0.1 | 1.0.2 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Immunization | C | 0..* | Immunization | Immunization event information be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation | C | 0..* | Immunization | Immunization event information be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation be-rule-vaccination-4: The encounter should have a location from be-vs-care-location | |||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: todo (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: todo (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | S | 0..* | Identifier | A unique business identifier for a vaccination entry | S | 0..* | Identifier | A unique business identifier for a vaccination entry | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: todo (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: todo (required): Identifies the purpose for this identifier, if known . | |||||||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: todo (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: todo (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | SΣ | 1..1 | string | The value that is unique Example General: 123456 | |||||||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 0..1 | Period | Time period when id is/was valid for use | |||||||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||
status | ?!SΣ | 1..1 | code | The status of this vaccination record entry Binding: todo (required): A set of codes indicating the current status of an Immunization. | ?!SΣ | 1..1 | code | The status of this vaccination record entry Binding: todo (required): A set of codes indicating the current status of an Immunization. | |||||||||
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: todo (required) | S | 0..1 | CodeableConcept | Reason not done Binding: todo (required) | |||||||||
vaccineCode | 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: todo (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: todo (required) | |||||||||
patient | SΣ | 1..1 | Reference(https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient) | The patient that this received vaccination entry refers to | SΣ | 1..1 | Reference(https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient) | The patient that this received vaccination entry refers to | |||||||||
encounter | S | 0..1 | Reference(Encounter) | Encounter immunization was part of | S | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||||
Slices for occurrence[x] | Σ | 1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Closed by type:$this | Σ | 1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Closed by type:$this | |||||||||
recorded | S | 1..1 | dateTime | The date/time when the vaccination event has been recorded | S | 1..1 | dateTime | The date/time when the vaccination event has been recorded | |||||||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | Σ | 0..1 | boolean | Indicates context the data was recorded in | |||||||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: todo (example): The source of the data for a record which is not from a primary source. | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: todo (example): The source of the data for a record which is not from a primary source. | |||||||||||
location | 0..0 | 0..0 | |||||||||||||||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||||||||
lotNumber | 0..0 | 0..0 | |||||||||||||||
expirationDate | 0..0 | 0..0 | |||||||||||||||
site | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: todo (required) | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: todo (required) | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | Σ | 0..* | Coding | Code defined by a terminology system | |||||||||
text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |||||||||
route | S | 0..1 | CodeableConcept | How vaccine entered body Binding: todo (required) | S | 0..1 | CodeableConcept | How vaccine entered body Binding: todo (required) | |||||||||
doseQuantity | S | 0..1 | Quantity | Amount of vaccine administered | S | 0..1 | Quantity | Amount of vaccine administered | |||||||||
performer | SΣ | 0..* | BackboneElement | Who performed event | SΣ | 0..* | BackboneElement | Who performed event | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: todo (extensible): The role a practitioner or organization plays in the immunization event. | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: todo (extensible): The role a practitioner or organization plays in the immunization event. | |||||||||
actor | Σ | 1..1 | Reference(https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner | https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization | https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole) | Individual or organization who was performing | Σ | 1..1 | Reference(https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner | https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization | https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole) | Individual or organization who was performing | |||||||||
note | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |||||||||
reasonCode | S | 0..* | CodeableConcept | Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition Binding: todo (preferred) | S | 0..* | CodeableConcept | Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition Binding: todo (preferred) | |||||||||
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why vaccination has occurred or not (reference to a finding) | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why vaccination has occurred or not (reference to a finding) | |||||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 0..1 | boolean | Dose potency | |||||||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: todo (example): The reason why a dose is considered to be subpotent. | 0..* | CodeableConcept | Reason for being subpotent Binding: todo (example): The reason why a dose is considered to be subpotent. | |||||||||||
education | C | 0..* | BackboneElement | Educational material presented to patient | C | 0..* | BackboneElement | Educational material presented to patient | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
documentType | 0..1 | string | Educational material document identifier | 0..1 | string | Educational material document identifier | |||||||||||
reference | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||||||||||
publicationDate | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||||||||||
presentationDate | 0..1 | dateTime | Educational material presentation date | 0..1 | dateTime | Educational material presentation date | |||||||||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: todo (example): The patient's eligibility for a vaccation program. | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: todo (example): The patient's eligibility for a vaccation program. | |||||||||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: todo (example): The source of funding used to purchase the vaccine administered. | 0..1 | CodeableConcept | Funding source for the vaccine Binding: todo (example): The source of funding used to purchase the vaccine administered. | |||||||||||
reaction | S | 0..* | BackboneElement | Reaction immediately after vaccination (15-30 minutes) | S | 0..* | BackboneElement | Reaction immediately after vaccination (15-30 minutes) | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
date | 1..1 | dateTime | When reaction started | 1..1 | dateTime | When reaction started | |||||||||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(Observation) | Additional information on reaction | |||||||||||
reported | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||||||||||
protocolApplied | S | 0..0 | S | 0..0 | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
series | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||||||||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: todo (example): The vaccine preventable disease the dose is being administered for. | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: todo (example): The vaccine preventable disease the dose is being administered for. | |||||||||||
doseNumber[x] | 1..1 | positiveInt, string | Dose number within series | 1..1 | positiveInt, string | Dose number within series | |||||||||||
seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | 0..1 | positiveInt, string | Recommended number of doses for immunity | |||||||||||
Documentation for this format |