Immunizations
The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section includes current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized.
Immunization
This profile describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.
Two extensions are optionally used by this profile:
- the first one provides the details about the assertion (e.g. who did the assertion, when was done);
- the second one provides the list of diseases targeted by this vaccine.
The vaccinationProtocol has been removed by this version of the profile as pre-adoption of the R4.
Tree view
Immunization-uv-ips (Immunization) | http://hl7.org/fhir/StructureDefinition/Immunization | ||
extension | |||
statementDetails | ..1 | Extension(Complex) | |
statementNote | ..0 | ||
targetDiseases | S | Extension(Codeable Concept) | |
status | S | Fixed Value | |
notGiven | Fixed Value | ||
vaccineCode | S | ||
coding | coding with translations | ||
pharmaceuticalProduct-L1 | coding with translations | ||
system | 1.. | Fixed Value | |
code | 1.. | ||
pharmaceuticalProduct-L2 | coding with translations | ||
system | 1.. | Fixed Value | |
code | 1.. | ||
pharmaceuticalProduct-L3 | coding with translations | ||
system | 1.. | Fixed Value | |
code | 1.. | ||
pharmaceuticalProduct-L4 | coding with translations | ||
system | 1.. | Fixed Value | |
code | 1.. | ||
medicinalProduct | S | coding with translations | |
system | 1.. | Fixed Value | |
code | 1.. | ||
display | |||
packagedProduct | S | coding with translations | |
system | 1.. | Fixed Value | |
code | 1.. | ||
display | |||
atcClass | ..1 | coding with translationsBinding | |
system | 1.. | Fixed Value | |
code | 1.. | ||
absentOrUnknownImmunization | S | ..1 | coding with translationsBinding |
system | 1.. | Fixed Value | |
code | 1.. | ||
text | S | ||
patient | S | ||
reference | S | ||
identifier | ..0 | ||
date | S | 1.. | |
manufacturer | |||
identifier | ..0 | ||
site | |||
coding | coding with translationsBinding | ||
route | Binding | ||
coding | coding with translationsBinding | ||
practitioner | S | ..1 | |
actor | S | ||
reference | S | ||
identifier | ..0 | ||
explanation | |||
reasonNotGiven | ..1 | ||
coding | coding with translations | ||
vaccinationProtocol | ..0 |
Immunization | |
Definition | Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed. If it describes a reported information the details about the assertion (e.g. who did the assertion, when was done) can be optionally documented in the in the statement extension. |
Immunization.extension | |
Slicing | Unordered, Open, by url(Value) |
Immunization.extension:statementDetails | |
Definition | Information about who reported this immunization and when |
Cardinality | ...1 |
Type | Extension(Complex) |
Immunization.extension:statementDetails.extension:statementNote | |
Cardinality | ...0 |
Immunization.extension:targetDiseases | |
Definition | Disease targeted by this vaccine |
Type | Extension(Codeable Concept) |
Must Support | True |
Immunization.status | |
Must Support | True |
Fixed Value | completed |
Immunization.notGiven | |
Comments | This element is always false for the IPS as we report immunization that happened |
Fixed Value | true |
Immunization.vaccineCode | |
Definition | Vaccine that was administered or was to be administered. Several kinds of vaccine product coding could be provided . The IPS requires that either the Vaccine for type of disease or the known absent / unknown code is provided. Other coded information that identifies / classifies the administered product (e.g. the medicinal prodoct or the product class), including IDMP identifiers, can be provided as well. |
Must Support | True |
Immunization.vaccineCode.coding | |
Definition | A representation of the vaccine in a code system. The representation can be granular or may also be a class or category. |
Type | coding with translations |
Slicing | Unordered, Open, by system(Value) |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L1 | |
Definition | IDMP PhPID Level 1 (Implies ingredients) or any equivalent Pharmaceutical Product identifier. Pharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the generic composition, such as ingredients and route of administration, separate from any other details such as regulatory authorisation, organisation, packaging or naming. The PhPID can be specified at various levels of detail for a given Pharmaceutical Product. |
Type | coding with translations |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L1.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/sid/phpid-l1 |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L1.code | |
Cardinality | 1 |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L2 | |
Definition | IDMP PhPID Level 2 (Implies ingredients and strength) or any equivalent Pharmaceutical Product identifier. Pharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the generic composition, such as ingredients and route of administration, separate from any other details such as regulatory authorisation, organisation, packaging or naming. The PhPID can be specified at various levels of detail for a given Pharmaceutical Product. |
Type | coding with translations |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L2.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/sid/phpid-l2 |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L2.code | |
Cardinality | 1 |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L3 | |
Definition | IDMP PhPID Level 3 (Implies ingredients and dose form) or any equivalent Pharmaceutical Product identifier. Pharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the generic composition, such as ingredients and route of administration, separate from any other details such as regulatory authorisation, organisation, packaging or naming. The PhPID can be specified at various levels of detail for a given Pharmaceutical Product. |
Type | coding with translations |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L3.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/sid/phpid-l3 |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L3.code | |
Cardinality | 1 |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L4 | |
Definition | IDMP PhPID Level 4 (Implies ingredients, strength, and dose form) or any equivalent Pharmaceutical Product identifier. Pharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the generic composition, such as ingredients and route of administration, separate from any other details such as regulatory authorisation, organisation, packaging or naming. The PhPID can be specified at various levels of detail for a given Pharmaceutical Product. |
Type | coding with translations |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L4.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/sid/phpid-l4 |
Immunization.vaccineCode.coding:pharmaceuticalProduct-L4.code | |
Cardinality | 1 |
Immunization.vaccineCode.coding:medicinalProduct | |
Definition | IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorisation numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which when each segment is valued shall define a specific MPID concept. The pattern is: • a) Country code segment (ISO 3166-1 alpha-2 code elements); • b) Marketing Authorization Holder (Organization Identifier) code segment; • c) Medicinal Product code segment (Unique Medicinal Product Identifier). • Any change of the values related to these three code segments shall result in the assignment of a new MPID. |
Type | coding with translations |
Must Support | True |
Immunization.vaccineCode.coding:medicinalProduct.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/sid/mpid |
Immunization.vaccineCode.coding:medicinalProduct.code | |
Cardinality | 1 |
Immunization.vaccineCode.coding:medicinalProduct.display | |
Definition | Name of the Medicinal Product, in some cases it corresponds to the brand name. |
Immunization.vaccineCode.coding:packagedProduct | |
Definition | IDMP Packaged Medicinal Product Identifier or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package; The PCID shall use a common segment pattern related to a package of a Medicinal Product, which when each segment is valued, shall define a specific PCID concept. The pattern is: • a) MPID for the Medicinal Product • b) package description code segment, which refers to a unique identifier for each package. |
Type | coding with translations |
Must Support | True |
Immunization.vaccineCode.coding:packagedProduct.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/sid/pcid |
Immunization.vaccineCode.coding:packagedProduct.code | |
Cardinality | 1 |
Immunization.vaccineCode.coding:packagedProduct.display | |
Definition | Name of the Packaged Medicinal Product, in some cases it corresponds to the brand name. |
Immunization.vaccineCode.coding:atcClass | |
Definition | WHO classification or cluster of products such as ATC, SNOMED VMP or national/local classification of products |
Cardinality | ...1 |
Type | coding with translations |
Binding | WHOATC (required) |
Immunization.vaccineCode.coding:atcClass.system | |
Cardinality | 1 |
Fixed Value | http://www.whocc.no/atc |
Immunization.vaccineCode.coding:atcClass.code | |
Cardinality | 1 |
Immunization.vaccineCode.coding:absentOrUnknownImmunization | |
Definition | A reference to a code indicating that there there are no known immunizations or that this information is unknown. |
Cardinality | ...1 |
Type | coding with translations |
Binding | IPSNoImmunizationInfo (required) |
Must Support | True |
Immunization.vaccineCode.coding:absentOrUnknownImmunization.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/ips/CodeSystem/absent-unknown |
Immunization.vaccineCode.coding:absentOrUnknownImmunization.code | |
Cardinality | 1 |
Immunization.vaccineCode.text | |
Must Support | True |
Comments | The text should be at the displayName level and not on this level. |
Immunization.patient | |
Must Support | True |
Immunization.patient.reference | |
Must Support | True |
Immunization.patient.identifier | |
Cardinality | ...0 |
Immunization.date | |
Cardinality | 1 |
Must Support | True |
Immunization.manufacturer.identifier | |
Cardinality | ...0 |
Immunization.site.coding | |
Type | coding with translations |
Binding | IPSTargetSiteCode (preferred) |
Immunization.route | |
Binding | IPSRouteOfAdmin (required) |
Immunization.route.coding | |
Type | coding with translations |
Binding | ?? (required) |
Immunization.practitioner | |
Cardinality | ...1 |
Must Support | True |
Immunization.practitioner.actor | |
Must Support | True |
Immunization.practitioner.actor.reference | |
Must Support | True |
Immunization.practitioner.actor.identifier | |
Cardinality | ...0 |
Immunization.explanation.reasonNotGiven | |
Cardinality | ...1 |
Immunization.explanation.reasonNotGiven.coding | |
Type | coding with translations |
Immunization.vaccinationProtocol | |
Cardinality | ...0 |
Comments | Preadoption of R4 |