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

statementNote..0
targetDiseasesSExtension(Codeable Concept)
statusSFixed Value
notGivenFixed Value
system1..Fixed Value
code1..
system1..Fixed Value
code1..
system1..Fixed Value
code1..
system1..Fixed Value
code1..
system1..Fixed Value
code1..
display
system1..Fixed Value
code1..
display
system1..Fixed Value
code1..
system1..Fixed Value
code1..
textS
referenceS
identifier..0
dateS1..
identifier..0
codingcoding with translationsBinding
codingcoding with translationsBinding
referenceS
identifier..0
codingcoding 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
ShortImmunization Statement detail
Definition

Information about who reported this immunization and when

Cardinality..1
TypeExtension(Complex)
Immunization.extension:statementDetails.extension:statementNote
Cardinality..0
Immunization.extension:targetDiseases
ShortTarget disease
Definition

Disease targeted by this vaccine

TypeExtension(Codeable Concept)
Must SupportTrue
Immunization.status
Must SupportTrue
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 SupportTrue
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.

Typecoding with translations
Slicing

Unordered, Open, by system(Value)

This slicing on the coding element of vaccineCode is open, with discriminator based on the value of the Coding.system element. It supports both identifiers and categories or classes for representing the vaccine. It carries one slice for each of the IDMP identifiers, plus one slice for the ATC classification. A special slice is defined to carry the absent or unknown property. Other representations of the vaccine (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jursisdiction code systems, or any classification) use extra slices, since the slicing is open. The IDMP slices are provisional, and will be usable when the IDMP identifiers become available.

Immunization.vaccineCode.coding:pharmaceuticalProduct-L1
ShortPharmaceutical Product Identifier, Level 1
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.

Typecoding with translations
Immunization.vaccineCode.coding:pharmaceuticalProduct-L1.system
Cardinality1
Fixed Value
http://hl7.org/fhir/sid/phpid-l1
Immunization.vaccineCode.coding:pharmaceuticalProduct-L1.code
Cardinality1
Immunization.vaccineCode.coding:pharmaceuticalProduct-L2
ShortPharmaceutical Product Identifier, Level 2
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.

Typecoding with translations
Immunization.vaccineCode.coding:pharmaceuticalProduct-L2.system
Cardinality1
Fixed Value
http://hl7.org/fhir/sid/phpid-l2
Immunization.vaccineCode.coding:pharmaceuticalProduct-L2.code
Cardinality1
Immunization.vaccineCode.coding:pharmaceuticalProduct-L3
ShortPharmaceutical Product Identifier, Level 3
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.

Typecoding with translations
Immunization.vaccineCode.coding:pharmaceuticalProduct-L3.system
Cardinality1
Fixed Value
http://hl7.org/fhir/sid/phpid-l3
Immunization.vaccineCode.coding:pharmaceuticalProduct-L3.code
Cardinality1
Immunization.vaccineCode.coding:pharmaceuticalProduct-L4
ShortPharmaceutical Product Identifier, Level 4
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.

Typecoding with translations
Immunization.vaccineCode.coding:pharmaceuticalProduct-L4.system
Cardinality1
Fixed Value
http://hl7.org/fhir/sid/phpid-l4
Immunization.vaccineCode.coding:pharmaceuticalProduct-L4.code
Cardinality1
Immunization.vaccineCode.coding:medicinalProduct
ShortMedicinal Product Identifier
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.

Typecoding with translations
Must SupportTrue
Immunization.vaccineCode.coding:medicinalProduct.system
Cardinality1
Fixed Value
http://hl7.org/fhir/sid/mpid
Immunization.vaccineCode.coding:medicinalProduct.code
Cardinality1
Immunization.vaccineCode.coding:medicinalProduct.display
ShortName of the Medicinal Product
Definition

Name of the Medicinal Product, in some cases it corresponds to the brand name.

Immunization.vaccineCode.coding:packagedProduct
ShortPackaged Medicinal Product Identifier
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.

Typecoding with translations
Must SupportTrue
Immunization.vaccineCode.coding:packagedProduct.system
Cardinality1
Fixed Value
http://hl7.org/fhir/sid/pcid
Immunization.vaccineCode.coding:packagedProduct.code
Cardinality1
Immunization.vaccineCode.coding:packagedProduct.display
ShortName of the Packaged Medicinal Product
Definition

Name of the Packaged Medicinal Product, in some cases it corresponds to the brand name.

Immunization.vaccineCode.coding:atcClass
ShortWHO ATC classification
Definition

WHO classification or cluster of products such as ATC, SNOMED VMP or national/local classification of products

Cardinality..1
Typecoding with translations
Binding

WHOATC (required)

Immunization.vaccineCode.coding:atcClass.system
Cardinality1
Fixed Value
http://www.whocc.no/atc
Immunization.vaccineCode.coding:atcClass.code
Cardinality1
Immunization.vaccineCode.coding:absentOrUnknownImmunization
ShortAbsent Unknown Immunization
Definition

A reference to a code indicating that there there are no known immunizations or that this information is unknown.

Cardinality..1
Typecoding with translations
Binding

IPSNoImmunizationInfo (required)

Must SupportTrue
Immunization.vaccineCode.coding:absentOrUnknownImmunization.system
Cardinality1
Fixed Value
http://hl7.org/fhir/ips/CodeSystem/absent-unknown
Immunization.vaccineCode.coding:absentOrUnknownImmunization.code
Cardinality1
Immunization.vaccineCode.text
Must SupportTrue
Comments

The text should be at the displayName level and not on this level.

Immunization.patient
Must SupportTrue
Immunization.patient.reference
Must SupportTrue
Immunization.patient.identifier
Cardinality..0
Immunization.date
Cardinality1
Must SupportTrue
Immunization.manufacturer.identifier
Cardinality..0
Immunization.site.coding
Typecoding with translations
Binding

IPSTargetSiteCode (preferred)

Immunization.route
Binding

IPSRouteOfAdmin (required)

Immunization.route.coding
Typecoding with translations
Binding

http://hl7.org/fhir/ips/ValueSet/routeOfAdministration-uv-ips (required)

Immunization.practitioner
Cardinality..1
Must SupportTrue
Immunization.practitioner.actor
Must SupportTrue
Immunization.practitioner.actor.reference
Must SupportTrue
Immunization.practitioner.actor.identifier
Cardinality..0
Immunization.explanation.reasonNotGiven
Cardinality..1
Immunization.explanation.reasonNotGiven.coding
Typecoding with translations
Immunization.vaccinationProtocol
Cardinality..0
Comments

Preadoption of R4