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: UV Subordinate Substance Administration

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.21.4.6--20230130093600 Version: 1.1.0-ballot
Draft as of 2023-01-30 Computable Name: UVSubordinateadministration
Other Identifiers: OID:2.16.840.1.113883.10.21.4.6 (use: official, )

Universal Subordinate Substance Administration to convey information about dosages

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 S 1..1 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)
​... event 0..1
​.... @code 0..1 code Binding: TimingEvent (required): TimingEvent

... 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.21.4.6
... @classCode 1..1 code Fixed Value: SBADM
... statusCode S 1..1 CS Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000 (required): ActStatusActiveCompletedAbortedSuspended

... doseQuantity S 0..1 IVL_PQ
.... @unit 0..1 code
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: urn:oid:2.16.840.1.113883.1.11.14570 (required): AdministrableDrugForm

... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct S 1..1 ManufacturedProduct
..... manufacturedMaterial S 1..1 Material
...... @nullFlavor 1..1 code Fixed Value: NA

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SubstanceAdministration.event.coderequiredTimingEvent
http://terminology.hl7.org/ValueSet/v3-TimingEvent
SubstanceAdministration.moodCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
SubstanceAdministration.statusCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
SubstanceAdministration.administrationUnitCoderequired

urn:oid:2.16.840.1.113883.1.11.14570

urn:oid:2.16.840.1.113883.1.11.14570
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 1..1 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.21.4.6
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000 (required): Mood Code Evn Int Rqo

... doseQuantity S 0..1 IVL_PQ
.... @unit 0..1 code
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: urn:oid:2.16.840.1.113883.1.11.14570 (required): AdministrableDrugForm

... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct S 1..1 ManufacturedProduct
..... manufacturedMaterial S 1..1 Material
...... @nullFlavor 1..1 code Binding: CDANullFlavor (required)
Fixed Value: NA

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
SubstanceAdministration.statusCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
SubstanceAdministration.administrationUnitCoderequired

urn:oid:2.16.840.1.113883.1.11.14570

urn:oid:2.16.840.1.113883.1.11.14570
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavorrequiredFixed Value: NA
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 1..1 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.21.4.6
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000 (required): Mood Code Evn Int Rqo

... id 0..* II
... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (example)
... @negationInd 0..1 bl
... text 0..1 ED
... statusCode S 1..1 CS Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000 (required): ActStatusActiveCompletedAbortedSuspended

... effectiveTime 0..*
.... 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 S 0..1 IVL_PQ
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @unit 0..1 code
.... @value 0..1 real
.... translation 0..* PQR
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 0..1 IVXB_PQ
.... center 0..1 PQ
.... width 0..1 PQ
.... high 0..1 IVXB_PQ
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: urn:oid:2.16.840.1.113883.1.11.14570 (required): AdministrableDrugForm

... 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 S 1..1 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
..... templateId 0..* II
..... @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 1..1 code Binding: CDANullFlavor (required)
Fixed Value: NA
...... 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 0..1 CE Binding: CDAMaterialEntityClassType (example)
...... name 0..1 EN
...... lotNumberText 0..1 ST
..... manufacturerOrganization 0..1 Organization
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... 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.moodCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
SubstanceAdministration.codeexampleCDAActSubstanceAdministrationCode
http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
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.doseQuantity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.doseQuantity.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.administrationUnitCoderequired

urn:oid:2.16.840.1.113883.1.11.14570

urn:oid:2.16.840.1.113883.1.11.14570
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.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavorrequiredFixed Value: NA
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.codeexampleCDAMaterialEntityClassType
http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType

This structure is derived from SubstanceAdministration

Summary

Mandatory: 10 elements
Must-Support: 6 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of SubstanceAdministration.templateId

Differential View

This structure is derived from SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 1..1 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)
​... event 0..1
​.... @code 0..1 code Binding: TimingEvent (required): TimingEvent

... 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.21.4.6
... @classCode 1..1 code Fixed Value: SBADM
... statusCode S 1..1 CS Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000 (required): ActStatusActiveCompletedAbortedSuspended

... doseQuantity S 0..1 IVL_PQ
.... @unit 0..1 code
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: urn:oid:2.16.840.1.113883.1.11.14570 (required): AdministrableDrugForm

... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct S 1..1 ManufacturedProduct
..... manufacturedMaterial S 1..1 Material
...... @nullFlavor 1..1 code Fixed Value: NA

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SubstanceAdministration.event.coderequiredTimingEvent
http://terminology.hl7.org/ValueSet/v3-TimingEvent
SubstanceAdministration.moodCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
SubstanceAdministration.statusCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
SubstanceAdministration.administrationUnitCoderequired

urn:oid:2.16.840.1.113883.1.11.14570

urn:oid:2.16.840.1.113883.1.11.14570

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 1..1 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.21.4.6
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000 (required): Mood Code Evn Int Rqo

... doseQuantity S 0..1 IVL_PQ
.... @unit 0..1 code
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: urn:oid:2.16.840.1.113883.1.11.14570 (required): AdministrableDrugForm

... consumable S 1..1 InfrastructureRoot
.... manufacturedProduct S 1..1 ManufacturedProduct
..... manufacturedMaterial S 1..1 Material
...... @nullFlavor 1..1 code Binding: CDANullFlavor (required)
Fixed Value: NA

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
SubstanceAdministration.statusCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
SubstanceAdministration.administrationUnitCoderequired

urn:oid:2.16.840.1.113883.1.11.14570

urn:oid:2.16.840.1.113883.1.11.14570
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavorrequiredFixed Value: NA
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 1..1 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.21.4.6
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000 (required): Mood Code Evn Int Rqo

... id 0..* II
... code 0..1 CD Binding: CDAActSubstanceAdministrationCode (example)
... @negationInd 0..1 bl
... text 0..1 ED
... statusCode S 1..1 CS Binding: http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000 (required): ActStatusActiveCompletedAbortedSuspended

... effectiveTime 0..*
.... 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 S 0..1 IVL_PQ
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @unit 0..1 code
.... @value 0..1 real
.... translation 0..* PQR
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 0..1 IVXB_PQ
.... center 0..1 PQ
.... width 0..1 PQ
.... high 0..1 IVXB_PQ
... rateQuantity 0..1 IVL_PQ
... maxDoseQuantity 0..1 RTO_PQ_PQ
... administrationUnitCode 0..1 CE Binding: urn:oid:2.16.840.1.113883.1.11.14570 (required): AdministrableDrugForm

... 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 S 1..1 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
..... templateId 0..* II
..... @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 1..1 code Binding: CDANullFlavor (required)
Fixed Value: NA
...... 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 0..1 CE Binding: CDAMaterialEntityClassType (example)
...... name 0..1 EN
...... lotNumberText 0..1 ST
..... manufacturerOrganization 0..1 Organization
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... 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.moodCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.4--20180321000000
SubstanceAdministration.codeexampleCDAActSubstanceAdministrationCode
http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredhttp://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
http://localhost:8877/exist/apps/fhir/ValueSet/2.16.840.1.113883.11.21.2--20170306000000
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.doseQuantity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.doseQuantity.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
SubstanceAdministration.administrationUnitCoderequired

urn:oid:2.16.840.1.113883.1.11.14570

urn:oid:2.16.840.1.113883.1.11.14570
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.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavorrequiredFixed Value: NA
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.codeexampleCDAMaterialEntityClassType
http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType

This structure is derived from SubstanceAdministration

Summary

Mandatory: 10 elements
Must-Support: 6 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of SubstanceAdministration.templateId

 

Other representations of profile: CSV, Excel