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

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

An Immunization entry describes immunization substance administrations that have actually occurred. 

Usage:

Formal Views of Template Content

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

This structure is derived from SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..* SubstanceAdministration XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
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.15
... @classCode 1..1 code Fixed Value: SBADM
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: urn:oid:2.16.840.1.113883.1.11.19709 (required): ActSubstanceAdministrationImmunizationCode

... statusCode S 1..1 CS
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1 SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct 0..* ManufacturedProduct
..... @classCode 1..1 code Fixed Value: MANU
..... 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
..... 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
..... manufacturerOrganization S 0..1 Organization
... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
..... @typeCode 1..1 code Fixed Value: RSON
..... Slices for substanceAdministration Content/Rules for all slices
...... substanceAdministration:entryRelationship-1 1..1 UVSubordinateadministration Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SubstanceAdministration.coderequired

urn:oid:2.16.840.1.113883.1.11.19709

urn:oid:2.16.840.1.113883.1.11.19709
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..* SubstanceAdministration XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
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.15
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... code S 1..1 CD Binding: urn:oid:2.16.840.1.113883.1.11.19709 (required): ActSubstanceAdministrationImmunizationCode

... statusCode S 1..1 CS Binding: ActStatus (required)
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct 0..* ManufacturedProduct
..... 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 0..1 cs 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
..... manufacturerOrganization S 0..1 Organization
... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... Slices for substanceAdministration Content/Rules for all slices
...... substanceAdministration:entryRelationship-1 S 1..1 UVSubordinateadministration Base for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0
SubstanceAdministration.coderequired

urn:oid:2.16.840.1.113883.1.11.19709

urn:oid:2.16.840.1.113883.1.11.19709
SubstanceAdministration.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.consumable.manufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..* SubstanceAdministration XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... 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.15
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... id 0..* II
... code S 1..1 CD Binding: urn:oid:2.16.840.1.113883.1.11.19709 (required): ActSubstanceAdministrationImmunizationCode

... @negationInd 0..1 bl
... text 0..1 ED
... statusCode S 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: completed
.... @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)
... effectiveTime S 1..1
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... routeCode 0..1 CE Binding: RouteOfAdministration (example)
... approachSiteCode 0..* CD Binding: v3 Value Set ActSite (example)
... doseQuantity 0..1 IVL_PQ
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: AdministrableDrugForm (example)
... consumable S 1..1 InfrastructureRoot
.... @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
.... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct 0..* ManufacturedProduct
..... @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
..... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
...... 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 0..1 cs Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... 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
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author S 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
..... @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
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... Slices for substanceAdministration Content/Rules for all slices
...... substanceAdministration:entryRelationship-1 S 1..1 UVSubordinateadministration Base for all types and resources
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SubstanceAdministration.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0
SubstanceAdministration.coderequired

urn:oid:2.16.840.1.113883.1.11.19709

urn:oid:2.16.840.1.113883.1.11.19709
SubstanceAdministration.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.routeCodeexampleRouteOfAdministration
http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration
SubstanceAdministration.approachSiteCodeexampleActSite
http://terminology.hl7.org/ValueSet/v3-ActSite
SubstanceAdministration.administrationUnitCodeexampleAdministrableDrugForm
http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.consumable.manufacturedProduct.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.entryRelationship:entryRelationship-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:entryRelationship-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:

This structure is derived from SubstanceAdministration

Summary

Mandatory: 10 elements(11 nested mandatory elements)
Must-Support: 10 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of SubstanceAdministration.templateId
  • The element 2 is sliced based on the values of SubstanceAdministration.consumable.manufacturedProduct.templateId
  • The element 1 is sliced based on the value of SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation
  • The element 1 is sliced based on the value of SubstanceAdministration.entryRelationship

Differential View

This structure is derived from SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..* SubstanceAdministration XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
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.15
... @classCode 1..1 code Fixed Value: SBADM
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: urn:oid:2.16.840.1.113883.1.11.19709 (required): ActSubstanceAdministrationImmunizationCode

... statusCode S 1..1 CS
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1 SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct 0..* ManufacturedProduct
..... @classCode 1..1 code Fixed Value: MANU
..... 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
..... 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
..... manufacturerOrganization S 0..1 Organization
... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
..... @typeCode 1..1 code Fixed Value: RSON
..... Slices for substanceAdministration Content/Rules for all slices
...... substanceAdministration:entryRelationship-1 1..1 UVSubordinateadministration Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SubstanceAdministration.coderequired

urn:oid:2.16.840.1.113883.1.11.19709

urn:oid:2.16.840.1.113883.1.11.19709
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..* SubstanceAdministration XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
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.15
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... code S 1..1 CD Binding: urn:oid:2.16.840.1.113883.1.11.19709 (required): ActSubstanceAdministrationImmunizationCode

... statusCode S 1..1 CS Binding: ActStatus (required)
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct 0..* ManufacturedProduct
..... 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 0..1 cs 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
..... manufacturerOrganization S 0..1 Organization
... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... Slices for substanceAdministration Content/Rules for all slices
...... substanceAdministration:entryRelationship-1 S 1..1 UVSubordinateadministration Base for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0
SubstanceAdministration.coderequired

urn:oid:2.16.840.1.113883.1.11.19709

urn:oid:2.16.840.1.113883.1.11.19709
SubstanceAdministration.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.consumable.manufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..* SubstanceAdministration XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... 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.15
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... id 0..* II
... code S 1..1 CD Binding: urn:oid:2.16.840.1.113883.1.11.19709 (required): ActSubstanceAdministrationImmunizationCode

... @negationInd 0..1 bl
... text 0..1 ED
... statusCode S 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: completed
.... @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)
... effectiveTime S 1..1
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... routeCode 0..1 CE Binding: RouteOfAdministration (example)
... approachSiteCode 0..* CD Binding: v3 Value Set ActSite (example)
... doseQuantity 0..1 IVL_PQ
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: AdministrableDrugForm (example)
... consumable S 1..1 InfrastructureRoot
.... @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
.... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct 0..* ManufacturedProduct
..... @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
..... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
...... 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 0..1 cs Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... 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
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author S 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
..... @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
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... Slices for substanceAdministration Content/Rules for all slices
...... substanceAdministration:entryRelationship-1 S 1..1 UVSubordinateadministration Base for all types and resources
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SubstanceAdministration.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0
SubstanceAdministration.coderequired

urn:oid:2.16.840.1.113883.1.11.19709

urn:oid:2.16.840.1.113883.1.11.19709
SubstanceAdministration.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.routeCodeexampleRouteOfAdministration
http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration
SubstanceAdministration.approachSiteCodeexampleActSite
http://terminology.hl7.org/ValueSet/v3-ActSite
SubstanceAdministration.administrationUnitCodeexampleAdministrableDrugForm
http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.consumable.manufacturedProduct.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.codepreferredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondaryrequiredIPSWHOVaccines
http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
from this IG
SubstanceAdministration.entryRelationship:entryRelationship-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:entryRelationship-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:

This structure is derived from SubstanceAdministration

Summary

Mandatory: 10 elements(11 nested mandatory elements)
Must-Support: 10 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of SubstanceAdministration.templateId
  • The element 2 is sliced based on the values of SubstanceAdministration.consumable.manufacturedProduct.templateId
  • The element 1 is sliced based on the value of SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation
  • The element 1 is sliced based on the value of SubstanceAdministration.entryRelationship

 

Other representations of profile: CSV, Excel