International Patient Summary (IPS)
1.1.0-ballot - CI Build

International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions

Logical Model: IPS Immunization Medication Information

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.16--20240804211600 Version: 1.1.0-ballot
Draft as of 2024-08-04 Computable Name: IPSImmunizationMedicationInformation
Other Identifiers: OID:2.16.840.1.113883.10.22.4.16 (use: official, )

The Immunization Medication Information represents product information about the immunization substance. The vaccine manufacturer and vaccine lot number are typically recorded in the medical record and should be included if known.

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from ManufacturedProduct

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 0..* ManufacturedProduct XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.16
... @classCode 1..1 code Fixed Value: MANU
... manufacturedMaterial S 1..1 Material
.... code S 1..1 CE Binding: IPS Vaccines WHO ATC (preferred): IPS Vaccines

..... Slices for translation 1..* CD Slice: Unordered, Open by value:code
...... translation:primary 1..1 CE
...... translation:secondary 1..1 CE Binding: IPS Vaccines WHO ATC (required): IPS Vaccines WHO ATC

.... lotNumberText 0..1 ST

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ManufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
ManufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct C 0..* ManufacturedProduct XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.16
... @classCode 1..1 code Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... manufacturedMaterial S 1..1 Material
.... code S 1..1 CE Binding: IPS Vaccines WHO ATC (preferred): IPS Vaccines

..... Slices for translation 1..* CD Slice: Unordered, Open by value:code
...... translation:primary 1..1 CE
...... translation:secondary 1..1 CE Binding: IPS Vaccines WHO ATC (required): IPS Vaccines WHO ATC


.... lotNumberText 0..1 ST

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ManufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
ManufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
ManufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct C 0..* ManufacturedProduct XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:primary S 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.16
..... @extension 0..1 st
... @classCode 1..1 code Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... (Choice of one) 1..1
.... manufacturedLabeledDrug 0..1 LabeledDrug
.... manufacturedMaterial S 1..1 Material
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
..... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
Fixed Value: KIND
..... code S 1..1 CE Binding: IPS Vaccines WHO ATC (preferred): IPS Vaccines

...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @code 0..1 cs
...... @codeSystem 0..1 oid, uuid, ruid
...... @codeSystemName 0..1 st
...... @codeSystemVersion 0..1 st
...... @displayName 0..1 st
...... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... Slices for translation 1..* CD Slice: Unordered, Open by value:code
....... translation:primary 1..1 CE
....... translation:secondary 1..1 CE Binding: IPS Vaccines WHO ATC (required): IPS Vaccines WHO ATC


..... name 0..1 EN
..... lotNumberText 0..1 ST
... manufacturerOrganization S 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ManufacturedProduct.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
ManufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
ManufacturedProduct.manufacturedMaterial.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1

This structure is derived from ManufacturedProduct

Summary

Mandatory: 9 elements
Must-Support: 4 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of ManufacturedProduct.templateId
  • The element 1 is sliced based on the value of ManufacturedProduct.manufacturedMaterial.code.translation

Differential View

This structure is derived from ManufacturedProduct

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 0..* ManufacturedProduct XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.16
... @classCode 1..1 code Fixed Value: MANU
... manufacturedMaterial S 1..1 Material
.... code S 1..1 CE Binding: IPS Vaccines WHO ATC (preferred): IPS Vaccines

..... Slices for translation 1..* CD Slice: Unordered, Open by value:code
...... translation:primary 1..1 CE
...... translation:secondary 1..1 CE Binding: IPS Vaccines WHO ATC (required): IPS Vaccines WHO ATC

.... lotNumberText 0..1 ST

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ManufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
ManufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct C 0..* ManufacturedProduct XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.16
... @classCode 1..1 code Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... manufacturedMaterial S 1..1 Material
.... code S 1..1 CE Binding: IPS Vaccines WHO ATC (preferred): IPS Vaccines

..... Slices for translation 1..* CD Slice: Unordered, Open by value:code
...... translation:primary 1..1 CE
...... translation:secondary 1..1 CE Binding: IPS Vaccines WHO ATC (required): IPS Vaccines WHO ATC


.... lotNumberText 0..1 ST

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ManufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
ManufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
ManufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct C 0..* ManufacturedProduct XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:primary S 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.16
..... @extension 0..1 st
... @classCode 1..1 code Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... (Choice of one) 1..1
.... manufacturedLabeledDrug 0..1 LabeledDrug
.... manufacturedMaterial S 1..1 Material
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
..... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
Fixed Value: KIND
..... code S 1..1 CE Binding: IPS Vaccines WHO ATC (preferred): IPS Vaccines

...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @code 0..1 cs
...... @codeSystem 0..1 oid, uuid, ruid
...... @codeSystemName 0..1 st
...... @codeSystemVersion 0..1 st
...... @displayName 0..1 st
...... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... Slices for translation 1..* CD Slice: Unordered, Open by value:code
....... translation:primary 1..1 CE
....... translation:secondary 1..1 CE Binding: IPS Vaccines WHO ATC (required): IPS Vaccines WHO ATC


..... name 0..1 EN
..... lotNumberText 0..1 ST
... manufacturerOrganization S 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ManufacturedProduct.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
ManufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
ManufacturedProduct.manufacturedMaterial.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ManufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
product-choiceerrorManufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1

This structure is derived from ManufacturedProduct

Summary

Mandatory: 9 elements
Must-Support: 4 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of ManufacturedProduct.templateId
  • The element 1 is sliced based on the value of ManufacturedProduct.manufacturedMaterial.code.translation

 

Other representations of profile: CSV, Excel