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 Medication Statement

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

An IPS Medication entry describes a medication statement, that is a substance administration that has actually occurred (e.g., pills ingested or injections given) or are intended to occur (e.g., “take 2 tablets twice a day for the next 10 days”). Medication activities in “INT” mood are reflections of what a clinician intends a patient to be taking. For example, a clinician may intend that a patient to be administered Lisinopril 20 mg PO for blood pressure control. If what was actually administered was Lisinopril 10 mg., then the Medication activities in the “EVN” mood would reflect actual use.

The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay, but it could be derived from the medications information recorded into a GP’s EHR-system, in form of prescribed medication, or administration statements.

The medication information may come from sources such as the patient’s memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains.

A medication statement is usually less specific than an a prescription or a medication administration record.  

This entry is composed by a main substanceAdministration act and a subordinate substanceAdministration act, unless it is asserted that there are no medications data. 

The first conveys information as the product, the period of administration and the route of administration; the latter is used to provide dosage information as the frequency of intakes or the amount of the medication given.

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 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)
​... low S 1..1
​... high S 0..1
... low 0..0
... center 0..0
​... width S 1..1
​.... @unit 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208 (required): Medication Time Units (UCUM)

​... low 0..1
​... width S 1..1
​.... @unit 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208 (required): Medication Time Units (UCUM)

... @nullFlavor 0..1 code
... 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.4
... @classCode 1..1 code Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 (required): MoodCodeEvnInt

... id S 0..* II
... code S 1..1 CD Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107 (required): IPS No Medications

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 1..1 CS Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended

... routeCode S 0..1 CE Binding: IPS Medicine Route of Administration (required): IPS Medicine Route of Administration

... doseQuantity 0..0
... rateQuantity 0..0
... administrationUnitCode 0..0
... consumable S 1..1 InfrastructureRoot
.... @typeCode 1..1 code Fixed Value: CSM
.... manufacturedProduct S 0..* ManufacturedProduct
..... @classCode 0..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.2
..... manufacturedMaterial S 0..* Material
...... @classCode 0..1 code Fixed Value: MMAT
...... @determinerCode 0..1 code Fixed Value: KIND
...... 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.3
...... name S 0..1 EN
​...... formCode S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: IPS Medicine Doseform (required): IPS Medicine Doseform

​...... asContent 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Fixed Value: CONT
​....... quantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​........ @value 1..1 decimal
​....... containerPackagedProduct S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @classCode 1..1 code Fixed Value: CONT
​........ @determinerCode 1..1 code Fixed Value: KIND
​........ code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ name 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ formCode S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: Medicine Package (required): Medicine Package

​........ capacityQuantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​......... @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​......... @value 1..1 decimal
​........ asContent S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​......... @classCode 1..1 code Fixed Value: CONT
​......... quantity S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​.......... @value 1..1 decimal
​......... containerPackagedProduct S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... @classCode 1..1 code Fixed Value: CONT
​.......... @determinerCode 1..1 code Fixed Value: KIND
​.......... code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... name S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... formCode S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: Medicine Package (required): Medicine Package

​.......... capacityQuantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........... @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​........... @value 1..1 decimal
​.......... asContent S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........... @classCode 1..1 code Fixed Value: CONT
​........... quantity S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​............ @value 1..1 decimal
​........... containerPackagedProduct S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ @classCode 1..1 code Fixed Value: CONT
​............ @determinerCode 1..1 code Fixed Value: KIND
​............ code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ name S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ formCode S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: Medicine Package (required): Medicine Package

​............ capacityQuantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............. @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​............. @value 1..1 decimal
​...... asSpecializedKind S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Fixed Value: GRIC
​....... generalizedMaterialKind S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @classCode 1..1 code Fixed Value: MMAT
​........ code S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: IPS WHO ATC (required): WHO ATC

​........ name 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​...... asSpecializedKind S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Fixed Value: GRIC
​....... generalizedMaterialKind S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @classCode 1..1 code Fixed Value: MMAT
​........ code S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ name S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​...... ingredient S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Binding: RoleClassIngredientEntity (required): RoleClassIngredientEntity

​....... quantity S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ numerator S 1..1
​......... @unit 1..1 code Binding: Medicine Strength Numerator (required): Medicine Strength Numerator

​......... @value 1..1 decimal
​........ denominator S 1..1
​......... @unit 1..1 code Binding: Medicine Strength Denominator (required): Medicine Strength Denominator

​......... @value 1..1 decimal
​....... ingredientSubstance SC 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
MD1723604N1l1l3l30l25l13l15: Either the name or the code of the substance (or both) shall be provided
​........ @classCode 1..1 code Fixed Value: MMAT
​........ @determinerCode 1..1 code Fixed Value: KIND
​........ code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: IPS Medicine Active Substances (extensible): IPS Medicine Active Substances

​......... originalText 0..*
​.......... reference 0..*
​......... Slices for translation 1.. Slice: Unordered, Open by value:code
​.......... translation:primary 1..1 CD
​........ name 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
... author 0..1 Author
.... 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.14
.... time S 1..1 TS
.... assignedAuthor S 1..1 AssignedAuthor
​..... @determinerCode 0..1 code Fixed Value: INSTANCE
​..... name S 1..*
​...... family S 1..*
​...... given S 1..*
..... @classCode 0..1 code Fixed Value: PSN
..... id S 1..* II
..... code S 0..1 CE
..... representedOrganization 0..1 Organization
...... id 0..* II
...... name 0..* ON
...... telecom 0..* TEL
...... addr 0..* AD
... 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: COMP
..... Slices for sequenceNumber Content/Rules for all slices
...... sequenceNumber:entryRelationship-1 C 1..1 INT entryRelationship-1: contains ()
..... 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.width.unitrequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
SubstanceAdministration.width.unitrequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
SubstanceAdministration.moodCoderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
SubstanceAdministration.coderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
SubstanceAdministration.statusCoderequiredActStatusCodeActiveCompletedAbortedSuspended
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.12--20170330000000
from this IG
SubstanceAdministration.routeCoderequiredIPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm)
http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.formCoderequiredIPSDoseForm
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.quantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.formCoderequiredIPSPackage
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.27--20170503000000
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.capacityQuantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.quantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.formCoderequiredIPSPackage
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.27--20170503000000
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.capacityQuantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.asContent.quantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.asContent.containerPackagedProduct.formCoderequiredIPSPackage
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.27--20170503000000
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.asContent.containerPackagedProduct.capacityQuantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asSpecializedKind.generalizedMaterialKind.coderequiredWHOATC
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.classCoderequiredRoleClassIngredientEntity
http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.quantity.numerator.unitrequiredIPSStrengthNumerator (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/strengthNumerator
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.quantity.denominator.unitrequiredIPSMedicineStrengthDenominator (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/strengthDenominator
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.ingredientSubstance.codeextensibleIPSActiveSubstances
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
MD1723604N1l1l3l30l25l13l15errorSubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.ingredientSubstanceEither the name or the code of the substance (or both) shall be provided
:
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1, SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 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 code Binding: CDANullFlavor (required)
... 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.4
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... id S 0..* II
... code S 1..1 CD Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107 (required): IPS No Medications

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 1..1 CS Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended

... routeCode S 0..1 CE Binding: IPS Medicine Route of Administration (required): IPS Medicine Route of Administration

... consumable S 1..1 InfrastructureRoot
.... @typeCode 1..1 code Binding: CDAParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct S 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.2
..... @classCode 0..1 cs Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
..... manufacturedMaterial S 0..* Material
...... 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.3
...... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
...... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
Fixed Value: KIND
...... name S 0..1 EN
... author 0..1 Author
.... 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.14
.... time S 1..1 TS
.... assignedAuthor S 1..1 AssignedAuthor
..... @classCode 0..1 code Binding: RoleClassAssignedEntity (required)
Fixed Value: PSN
..... id S 1..* II
..... code S 0..1 CE Binding: CDARoleCode (example)
..... representedOrganization 0..1 Organization
...... id 0..* II
...... name 0..* ON
...... telecom 0..* TEL
...... addr 0..* AD
... 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: COMP
..... Slices for sequenceNumber Content/Rules for all slices
...... sequenceNumber:entryRelationship-1 C 1..1 INT entryRelationship-1: contains ()
..... 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.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
SubstanceAdministration.coderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
SubstanceAdministration.statusCoderequiredActStatusCodeActiveCompletedAbortedSuspended
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.12--20170330000000
from this IG
SubstanceAdministration.routeCoderequiredIPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm)
http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
from this IG
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.consumable.manufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
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.author.assignedAuthor.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
SubstanceAdministration.author.assignedAuthor.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
SubstanceAdministration.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1, SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber:entryRelationship-1contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 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 code 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.4
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 (required): MoodCodeEvnInt

... id S 0..* II
... code S 1..1 CD Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107 (required): IPS No Medications

... @negationInd 0..1 bl
... text S 0..1 ED
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference S 1..1 TEL
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @value 1..1 url
..... useablePeriod 0..*
...... useablePeriod IVL_TS
...... useablePeriod EIVL_TS
...... useablePeriod PIVL_TS
...... useablePeriod SXPR_TS
..... @use 0..* cs Binding: TelecommunicationAddressUse (2.0.0) (required)
.... thumbnail 0..1 ED
... statusCode S 1..1 CS Binding: ActStatusActiveCompletedAbortedSuspended (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 S 0..1 CE Binding: IPS Medicine Route of Administration (required): IPS Medicine Route of Administration

... approachSiteCode 0..* CD Binding: v3 Value Set ActSite (example)
... maxDoseQuantity 0..1 RTO_PQ_PQ
... 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 1..1 code Binding: CDAParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct S 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.2
....... @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 0..* 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
...... 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.3
........ @extension 0..1 st
...... @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 S 0..1 EN
...... lotNumberText 0..1 ST
..... manufacturerOrganization 0..1 Organization
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..1 Author
.... @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.14
...... @extension 0..1 st
.... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUT
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... functionCode 0..1 CE
.... time S 1..1 TS
.... assignedAuthor S 1..1 AssignedAuthor
..... @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 code Binding: RoleClassAssignedEntity (required)
Fixed Value: PSN
..... id S 1..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code S 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... assignedPerson 0..1 Person
..... assignedAuthoringDevice 0..1 AuthoringDevice
..... representedOrganization 0..1 Organization
...... @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: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... id 0..* II
...... name 0..* ON
...... telecom 0..* TEL
...... addr 0..* AD
...... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
...... asOrganizationPartOf 0..1 OrganizationPartOf
... 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: COMP
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... Slices for sequenceNumber Content/Rules for all slices
...... sequenceNumber:entryRelationship-1 C 1..1 INT entryRelationship-1: contains ()
..... 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.moodCoderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
SubstanceAdministration.coderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
SubstanceAdministration.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.text.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.reference.userequiredTelecommunicationAddressUse
http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
SubstanceAdministration.statusCoderequiredActStatusCodeActiveCompletedAbortedSuspended
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.12--20170330000000
from this IG
SubstanceAdministration.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.routeCoderequiredIPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm)
http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
from this IG
SubstanceAdministration.approachSiteCodeexampleActSite
http://terminology.hl7.org/ValueSet/v3-ActSite
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.templateId:primary.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
SubstanceAdministration.author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.typeCoderequiredFixed Value: AUT
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.author.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
SubstanceAdministration.author.assignedAuthor.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
SubstanceAdministration.author.assignedAuthor.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
SubstanceAdministration.author.assignedAuthor.representedOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.representedOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.representedOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
SubstanceAdministration.author.assignedAuthor.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
SubstanceAdministration.author.assignedAuthor.representedOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS
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: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1, SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber: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(65 nested mandatory elements)
Must-Support: 50 elements
Fixed: 27 elements
Prohibited: 6 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 2 is sliced based on the values of SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.templateId
  • The element 1 is sliced based on the value of SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.ingredientSubstance.code.translation
  • The element 2 is sliced based on the values of SubstanceAdministration.author.templateId
  • The element 1 is sliced based on the value of SubstanceAdministration.entryRelationship

Differential View

This structure is derived from SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 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)
​... low S 1..1
​... high S 0..1
... low 0..0
... center 0..0
​... width S 1..1
​.... @unit 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208 (required): Medication Time Units (UCUM)

​... low 0..1
​... width S 1..1
​.... @unit 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208 (required): Medication Time Units (UCUM)

... @nullFlavor 0..1 code
... 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.4
... @classCode 1..1 code Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 (required): MoodCodeEvnInt

... id S 0..* II
... code S 1..1 CD Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107 (required): IPS No Medications

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 1..1 CS Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended

... routeCode S 0..1 CE Binding: IPS Medicine Route of Administration (required): IPS Medicine Route of Administration

... doseQuantity 0..0
... rateQuantity 0..0
... administrationUnitCode 0..0
... consumable S 1..1 InfrastructureRoot
.... @typeCode 1..1 code Fixed Value: CSM
.... manufacturedProduct S 0..* ManufacturedProduct
..... @classCode 0..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.2
..... manufacturedMaterial S 0..* Material
...... @classCode 0..1 code Fixed Value: MMAT
...... @determinerCode 0..1 code Fixed Value: KIND
...... 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.3
...... name S 0..1 EN
​...... formCode S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: IPS Medicine Doseform (required): IPS Medicine Doseform

​...... asContent 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Fixed Value: CONT
​....... quantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​........ @value 1..1 decimal
​....... containerPackagedProduct S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @classCode 1..1 code Fixed Value: CONT
​........ @determinerCode 1..1 code Fixed Value: KIND
​........ code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ name 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ formCode S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: Medicine Package (required): Medicine Package

​........ capacityQuantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​......... @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​......... @value 1..1 decimal
​........ asContent S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​......... @classCode 1..1 code Fixed Value: CONT
​......... quantity S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​.......... @value 1..1 decimal
​......... containerPackagedProduct S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... @classCode 1..1 code Fixed Value: CONT
​.......... @determinerCode 1..1 code Fixed Value: KIND
​.......... code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... name S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​.......... formCode S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: Medicine Package (required): Medicine Package

​.......... capacityQuantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........... @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​........... @value 1..1 decimal
​.......... asContent S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........... @classCode 1..1 code Fixed Value: CONT
​........... quantity S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​............ @value 1..1 decimal
​........... containerPackagedProduct S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ @classCode 1..1 code Fixed Value: CONT
​............ @determinerCode 1..1 code Fixed Value: KIND
​............ code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ name S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............ formCode S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: Medicine Package (required): Medicine Package

​............ capacityQuantity 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​............. @unit 0..1 code Binding: Quantity Units (required): Quantity Units

​............. @value 1..1 decimal
​...... asSpecializedKind S 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Fixed Value: GRIC
​....... generalizedMaterialKind S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @classCode 1..1 code Fixed Value: MMAT
​........ code S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: IPS WHO ATC (required): WHO ATC

​........ name 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​...... asSpecializedKind S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Fixed Value: GRIC
​....... generalizedMaterialKind S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ @classCode 1..1 code Fixed Value: MMAT
​........ code S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ name S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​...... ingredient S 0..* XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​....... @classCode 1..1 code Binding: RoleClassIngredientEntity (required): RoleClassIngredientEntity

​....... quantity S 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
​........ numerator S 1..1
​......... @unit 1..1 code Binding: Medicine Strength Numerator (required): Medicine Strength Numerator

​......... @value 1..1 decimal
​........ denominator S 1..1
​......... @unit 1..1 code Binding: Medicine Strength Denominator (required): Medicine Strength Denominator

​......... @value 1..1 decimal
​....... ingredientSubstance SC 1..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
MD1723604N1l1l3l30l25l13l15: Either the name or the code of the substance (or both) shall be provided
​........ @classCode 1..1 code Fixed Value: MMAT
​........ @determinerCode 1..1 code Fixed Value: KIND
​........ code 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
Binding: IPS Medicine Active Substances (extensible): IPS Medicine Active Substances

​......... originalText 0..*
​.......... reference 0..*
​......... Slices for translation 1.. Slice: Unordered, Open by value:code
​.......... translation:primary 1..1 CD
​........ name 0..1 XML Namespace: urn:hl7-org:pharm
XML: pharm (urn:hl7-org:pharm)
... author 0..1 Author
.... 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.14
.... time S 1..1 TS
.... assignedAuthor S 1..1 AssignedAuthor
​..... @determinerCode 0..1 code Fixed Value: INSTANCE
​..... name S 1..*
​...... family S 1..*
​...... given S 1..*
..... @classCode 0..1 code Fixed Value: PSN
..... id S 1..* II
..... code S 0..1 CE
..... representedOrganization 0..1 Organization
...... id 0..* II
...... name 0..* ON
...... telecom 0..* TEL
...... addr 0..* AD
... 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: COMP
..... Slices for sequenceNumber Content/Rules for all slices
...... sequenceNumber:entryRelationship-1 C 1..1 INT entryRelationship-1: contains ()
..... 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.width.unitrequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
SubstanceAdministration.width.unitrequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.21.1--20230201111208
SubstanceAdministration.moodCoderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
SubstanceAdministration.coderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
SubstanceAdministration.statusCoderequiredActStatusCodeActiveCompletedAbortedSuspended
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.12--20170330000000
from this IG
SubstanceAdministration.routeCoderequiredIPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm)
http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.formCoderequiredIPSDoseForm
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.quantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.formCoderequiredIPSPackage
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.27--20170503000000
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.capacityQuantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.quantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.formCoderequiredIPSPackage
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.27--20170503000000
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.capacityQuantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.asContent.quantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.asContent.containerPackagedProduct.formCoderequiredIPSPackage
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.27--20170503000000
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asContent.containerPackagedProduct.asContent.containerPackagedProduct.asContent.containerPackagedProduct.capacityQuantity.unitrequiredIPSQuantityUnits (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/quantityUnits
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.asSpecializedKind.generalizedMaterialKind.coderequiredWHOATC
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.classCoderequiredRoleClassIngredientEntity
http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.quantity.numerator.unitrequiredIPSStrengthNumerator (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/strengthNumerator
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.quantity.denominator.unitrequiredIPSMedicineStrengthDenominator (a valid code from UCUM)
http://hl7.org/fhir/uv/ips/ValueSet/strengthDenominator
from this IG
SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.ingredientSubstance.codeextensibleIPSActiveSubstances
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
MD1723604N1l1l3l30l25l13l15errorSubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.ingredientSubstanceEither the name or the code of the substance (or both) shall be provided
:
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1, SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber: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 S 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 code Binding: CDANullFlavor (required)
... 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.4
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... id S 0..* II
... code S 1..1 CD Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107 (required): IPS No Medications

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 1..1 CS Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended

... routeCode S 0..1 CE Binding: IPS Medicine Route of Administration (required): IPS Medicine Route of Administration

... consumable S 1..1 InfrastructureRoot
.... @typeCode 1..1 code Binding: CDAParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct S 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.2
..... @classCode 0..1 cs Binding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
..... manufacturedMaterial S 0..* Material
...... 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.3
...... @classCode 0..1 cs Binding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
...... @determinerCode 0..1 cs Binding: EntityDeterminerDetermined (required)
Fixed Value: KIND
...... name S 0..1 EN
... author 0..1 Author
.... 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.14
.... time S 1..1 TS
.... assignedAuthor S 1..1 AssignedAuthor
..... @classCode 0..1 code Binding: RoleClassAssignedEntity (required)
Fixed Value: PSN
..... id S 1..* II
..... code S 0..1 CE Binding: CDARoleCode (example)
..... representedOrganization 0..1 Organization
...... id 0..* II
...... name 0..* ON
...... telecom 0..* TEL
...... addr 0..* AD
... 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: COMP
..... Slices for sequenceNumber Content/Rules for all slices
...... sequenceNumber:entryRelationship-1 C 1..1 INT entryRelationship-1: contains ()
..... 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.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.classCoderequiredFixed Value: SBADM
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
SubstanceAdministration.moodCoderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
SubstanceAdministration.coderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
SubstanceAdministration.statusCoderequiredActStatusCodeActiveCompletedAbortedSuspended
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.12--20170330000000
from this IG
SubstanceAdministration.routeCoderequiredIPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm)
http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
from this IG
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.consumable.manufacturedProduct.classCoderequiredFixed Value: MANU
http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct
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.author.assignedAuthor.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
SubstanceAdministration.author.assignedAuthor.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
SubstanceAdministration.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration S 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 code 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.4
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClass (required)
Fixed Value: SBADM
... @moodCode 1..1 code Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 (required): MoodCodeEvnInt

... id S 0..* II
... code S 1..1 CD Binding: http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107 (required): IPS No Medications

... @negationInd 0..1 bl
... text S 0..1 ED
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference S 1..1 TEL
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @value 1..1 url
..... useablePeriod 0..*
...... useablePeriod IVL_TS
...... useablePeriod EIVL_TS
...... useablePeriod PIVL_TS
...... useablePeriod SXPR_TS
..... @use 0..* cs Binding: TelecommunicationAddressUse (2.0.0) (required)
.... thumbnail 0..1 ED
... statusCode S 1..1 CS Binding: ActStatusActiveCompletedAbortedSuspended (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 S 0..1 CE Binding: IPS Medicine Route of Administration (required): IPS Medicine Route of Administration

... approachSiteCode 0..* CD Binding: v3 Value Set ActSite (example)
... maxDoseQuantity 0..1 RTO_PQ_PQ
... 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 1..1 code Binding: CDAParticipationType (required)
Fixed Value: CSM
.... manufacturedProduct S 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.2
....... @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 0..* 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
...... 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.3
........ @extension 0..1 st
...... @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 S 0..1 EN
...... lotNumberText 0..1 ST
..... manufacturerOrganization 0..1 Organization
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..1 Author
.... @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.14
...... @extension 0..1 st
.... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUT
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... functionCode 0..1 CE
.... time S 1..1 TS
.... assignedAuthor S 1..1 AssignedAuthor
..... @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 code Binding: RoleClassAssignedEntity (required)
Fixed Value: PSN
..... id S 1..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code S 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... assignedPerson 0..1 Person
..... assignedAuthoringDevice 0..1 AuthoringDevice
..... representedOrganization 0..1 Organization
...... @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: EntityClassOrganization (required)
Fixed Value: ORG
...... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... id 0..* II
...... name 0..* ON
...... telecom 0..* TEL
...... addr 0..* AD
...... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
...... asOrganizationPartOf 0..1 OrganizationPartOf
... 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: COMP
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... Slices for sequenceNumber Content/Rules for all slices
...... sequenceNumber:entryRelationship-1 C 1..1 INT entryRelationship-1: contains ()
..... 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.moodCoderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000
SubstanceAdministration.coderequiredhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.79--20240802094107
SubstanceAdministration.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
SubstanceAdministration.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
SubstanceAdministration.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
SubstanceAdministration.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
SubstanceAdministration.text.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.text.reference.userequiredTelecommunicationAddressUse
http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
SubstanceAdministration.statusCoderequiredActStatusCodeActiveCompletedAbortedSuspended
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.12--20170330000000
from this IG
SubstanceAdministration.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
SubstanceAdministration.routeCoderequiredIPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm)
http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
from this IG
SubstanceAdministration.approachSiteCodeexampleActSite
http://terminology.hl7.org/ValueSet/v3-ActSite
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.templateId:primary.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
SubstanceAdministration.author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.typeCoderequiredFixed Value: AUT
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
SubstanceAdministration.author.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
SubstanceAdministration.author.assignedAuthor.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
SubstanceAdministration.author.assignedAuthor.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
SubstanceAdministration.author.assignedAuthor.representedOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.representedOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
SubstanceAdministration.author.assignedAuthor.representedOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
SubstanceAdministration.author.assignedAuthor.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
SubstanceAdministration.author.assignedAuthor.representedOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS
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: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullSubstanceAdministration.entryRelationship:entryRelationship-1, SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber: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(65 nested mandatory elements)
Must-Support: 50 elements
Fixed: 27 elements
Prohibited: 6 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 2 is sliced based on the values of SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.templateId
  • The element 1 is sliced based on the value of SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.ingredient.ingredientSubstance.code.translation
  • The element 2 is sliced based on the values of SubstanceAdministration.author.templateId
  • The element 1 is sliced based on the value of SubstanceAdministration.entryRelationship

 

Other representations of profile: CSV, Excel