SMART ICVP
0.1.0 - ci-build
SMART ICVP, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-icvp/ and changes regularly. See the Directory of published versions
Official URL: http://smart.who.int/icvp/StructureDefinition/DVC-ImmunizationUvIps | Version: 0.1.0 | |||
Draft as of 2024-10-07 | Computable Name: DVCImmunization |
This profile represents Immunization record for Digital Vaccine Certificates
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImmunizationUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | ImmunizationUvIps | Immunization event information | |
vaccineCode | 1..1 | CodeableConceptIPS | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: DVC - Vaccines (required) | |
occurrence[x] | 1..1 | dateTime | Vaccine administration date | |
lotNumber | S | 0..1 | string | Vaccine lot number |
performer | ||||
actor | 1..1 | Reference(mCSD Practitioner | mCSD Organization for Jurisdictions) | Individual or organization who was performing | |
Slices for protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority |
protocolApplied:protocolAppliedAuthority | S | 1..* | BackboneElement | Protocol followed by the provider |
authority | 0..1 | Reference(mCSD Organization for Jurisdictions) | Who is responsible for publishing the recommendations | |
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Disease Targeted (preferred) | |
doseNumber[x] | S | 1..1 | positiveInt, string | Dose number within series |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
doseNumberCodeableConcept | 1..1 | CodeableConcept | Extension URL: http://smart.who.int/icvp/StructureDefinition/doseNumberCodeableConcept | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.vaccineCode | required | DVCVaccineshttp://smart.who.int/icvp/ValueSet/DVCVaccines from this IG | |
Immunization.protocolApplied:protocolAppliedAuthority.targetDisease | preferred | DiseaseTargetedhttp://smart.who.int/icvp/ValueSet/DiseaseTargeted from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ImmunizationUvIps | Immunization event information | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||
vaccineCode | S | 1..1 | CodeableConceptIPS | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: DVC - Vaccines (required)
| ||||||
patient | SΣ | 1..1 | Reference(Patient (IPS)) | Who was immunized | ||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
data-absent-reason | S | 0..1 | code | occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||||
lotNumber | S | 0..1 | string | Vaccine lot number | ||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
Slices for protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority | ||||||
protocolApplied:All Slices | Content/Rules for all slices | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
doseNumber[x] | 1..1 | Dose number within series | ||||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
protocolApplied:protocolAppliedAuthority | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
authority | 0..1 | Reference(mCSD Organization for Jurisdictions) | Who is responsible for publishing the recommendations | |||||||
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Disease Targeted (preferred) | |||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumber[x]All Types | Content/Rules for all Types | |||||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
doseNumberCodeableConcept | 1..1 | CodeableConcept | Extension URL: http://smart.who.int/icvp/StructureDefinition/doseNumberCodeableConcept | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |
Immunization.vaccineCode | required | DVCVaccineshttp://smart.who.int/icvp/ValueSet/DVCVaccines from this IG | |
Immunization.protocolApplied:protocolAppliedAuthority.targetDisease | preferred | DiseaseTargetedhttp://smart.who.int/icvp/ValueSet/DiseaseTargeted from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ImmunizationUvIps | Immunization event information | |||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | 0..* | Identifier | Business identifier | |||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||||
vaccineCode | S | 1..1 | CodeableConceptIPS | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: DVC - Vaccines (required)
| ||||||
patient | SΣ | 1..1 | Reference(Patient (IPS)) | Who was immunized | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
id | 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 | |||||||
data-absent-reason | S | 0..1 | code | occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||||
lotNumber | S | 0..1 | string | Vaccine lot number | ||||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||||
site | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred) | |||||||
route | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred) | |||||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||||
performer | Σ | 0..* | BackboneElement | Who performed event | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||||
actor | Σ | 1..1 | Reference(mCSD Practitioner | mCSD Organization for Jurisdictions) | Individual or organization who was performing | ||||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
documentType | 0..1 | string | Educational material document identifier | |||||||
reference | 0..1 | uri | Educational material reference pointer | |||||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
date | 0..1 | dateTime | When reaction started | |||||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||||
Slices for protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority | ||||||
protocolApplied:All Slices | Content/Rules for all slices | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | 0..1 | string | Name of vaccine series | |||||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. | |||||||
doseNumber[x] | 1..1 | Dose number within series | ||||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||||
seriesDosesPositiveInt | positiveInt | |||||||||
seriesDosesString | string | |||||||||
protocolApplied:protocolAppliedAuthority | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | 0..1 | string | Name of vaccine series | |||||||
authority | 0..1 | Reference(mCSD Organization for Jurisdictions) | Who is responsible for publishing the recommendations | |||||||
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Disease Targeted (preferred) | |||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumber[x]All Types | Content/Rules for all Types | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
doseNumberCodeableConcept | 1..1 | CodeableConcept | Extension URL: http://smart.who.int/icvp/StructureDefinition/doseNumberCodeableConcept | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||||
seriesDosesPositiveInt | positiveInt | |||||||||
seriesDosesString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | required | DVCVaccineshttp://smart.who.int/icvp/ValueSet/DVCVaccines from this IG | ||||
Immunization.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.site | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Immunization.route | preferred | MedicineRouteOfAdministrationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | preferred | VaccineTargetDiseasesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips | ||||
Immunization.protocolApplied:protocolAppliedAuthority.targetDisease | preferred | DiseaseTargetedhttp://smart.who.int/icvp/ValueSet/DiseaseTargeted from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from ImmunizationUvIps
Summary
Mandatory: 4 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ImmunizationUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | ImmunizationUvIps | Immunization event information | |
vaccineCode | 1..1 | CodeableConceptIPS | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: DVC - Vaccines (required) | |
occurrence[x] | 1..1 | dateTime | Vaccine administration date | |
lotNumber | S | 0..1 | string | Vaccine lot number |
performer | ||||
actor | 1..1 | Reference(mCSD Practitioner | mCSD Organization for Jurisdictions) | Individual or organization who was performing | |
Slices for protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority |
protocolApplied:protocolAppliedAuthority | S | 1..* | BackboneElement | Protocol followed by the provider |
authority | 0..1 | Reference(mCSD Organization for Jurisdictions) | Who is responsible for publishing the recommendations | |
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Disease Targeted (preferred) | |
doseNumber[x] | S | 1..1 | positiveInt, string | Dose number within series |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
doseNumberCodeableConcept | 1..1 | CodeableConcept | Extension URL: http://smart.who.int/icvp/StructureDefinition/doseNumberCodeableConcept | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.vaccineCode | required | DVCVaccineshttp://smart.who.int/icvp/ValueSet/DVCVaccines from this IG | |
Immunization.protocolApplied:protocolAppliedAuthority.targetDisease | preferred | DiseaseTargetedhttp://smart.who.int/icvp/ValueSet/DiseaseTargeted from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ImmunizationUvIps | Immunization event information | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||
vaccineCode | S | 1..1 | CodeableConceptIPS | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: DVC - Vaccines (required)
| ||||||
patient | SΣ | 1..1 | Reference(Patient (IPS)) | Who was immunized | ||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
data-absent-reason | S | 0..1 | code | occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||||
lotNumber | S | 0..1 | string | Vaccine lot number | ||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
Slices for protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority | ||||||
protocolApplied:All Slices | Content/Rules for all slices | |||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
doseNumber[x] | 1..1 | Dose number within series | ||||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
protocolApplied:protocolAppliedAuthority | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
authority | 0..1 | Reference(mCSD Organization for Jurisdictions) | Who is responsible for publishing the recommendations | |||||||
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Disease Targeted (preferred) | |||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumber[x]All Types | Content/Rules for all Types | |||||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
doseNumberCodeableConcept | 1..1 | CodeableConcept | Extension URL: http://smart.who.int/icvp/StructureDefinition/doseNumberCodeableConcept | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |
Immunization.vaccineCode | required | DVCVaccineshttp://smart.who.int/icvp/ValueSet/DVCVaccines from this IG | |
Immunization.protocolApplied:protocolAppliedAuthority.targetDisease | preferred | DiseaseTargetedhttp://smart.who.int/icvp/ValueSet/DiseaseTargeted from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ImmunizationUvIps | Immunization event information | |||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | 0..* | Identifier | Business identifier | |||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||||
vaccineCode | S | 1..1 | CodeableConceptIPS | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: DVC - Vaccines (required)
| ||||||
patient | SΣ | 1..1 | Reference(Patient (IPS)) | Who was immunized | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | ||||||
id | 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 | |||||||
data-absent-reason | S | 0..1 | code | occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||||
lotNumber | S | 0..1 | string | Vaccine lot number | ||||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||||
site | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred) | |||||||
route | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred) | |||||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||||
performer | Σ | 0..* | BackboneElement | Who performed event | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||||
actor | Σ | 1..1 | Reference(mCSD Practitioner | mCSD Organization for Jurisdictions) | Individual or organization who was performing | ||||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
documentType | 0..1 | string | Educational material document identifier | |||||||
reference | 0..1 | uri | Educational material reference pointer | |||||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
date | 0..1 | dateTime | When reaction started | |||||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||||
Slices for protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority | ||||||
protocolApplied:All Slices | Content/Rules for all slices | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | 0..1 | string | Name of vaccine series | |||||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. | |||||||
doseNumber[x] | 1..1 | Dose number within series | ||||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||||
seriesDosesPositiveInt | positiveInt | |||||||||
seriesDosesString | string | |||||||||
protocolApplied:protocolAppliedAuthority | S | 1..* | BackboneElement | Protocol followed by the provider | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
series | 0..1 | string | Name of vaccine series | |||||||
authority | 0..1 | Reference(mCSD Organization for Jurisdictions) | Who is responsible for publishing the recommendations | |||||||
targetDisease | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Disease Targeted (preferred) | |||||||
doseNumber[x] | S | 1..1 | Dose number within series | |||||||
doseNumber[x]All Types | Content/Rules for all Types | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
doseNumberCodeableConcept | 1..1 | CodeableConcept | Extension URL: http://smart.who.int/icvp/StructureDefinition/doseNumberCodeableConcept | |||||||
doseNumberPositiveInt | positiveInt | |||||||||
doseNumberString | string | |||||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||||
seriesDosesPositiveInt | positiveInt | |||||||||
seriesDosesString | string | |||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | required | DVCVaccineshttp://smart.who.int/icvp/ValueSet/DVCVaccines from this IG | ||||
Immunization.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.site | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Immunization.route | preferred | MedicineRouteOfAdministrationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | preferred | VaccineTargetDiseasesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips | ||||
Immunization.protocolApplied:protocolAppliedAuthority.targetDisease | preferred | DiseaseTargetedhttp://smart.who.int/icvp/ValueSet/DiseaseTargeted from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from ImmunizationUvIps
Summary
Mandatory: 4 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron