Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: SubstanceAdministration (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration Version: 2.0.1
Active as of 2023-10-03 Computable Name: CDAR2.SubstanceAdministration

A derivative of the RIM SubstanceAdministration class, used for representing medication-related events such as medication history or planned medication administration orders. SubstanceAdministration.negationInd, when set to “true”, is a positive assertion that the SubstanceAdministration as a whole is negated. Some properties such as SubstanceAdministration.id, SubstanceAdministration.moodCode, and the participations are not affected. These properties always have the same meaning: i.e., the author remains the author of the negative SubstanceAdministration. A substance administration statement with negationInd is still a statement about the specific fact described by the SubstanceAdministration. For instance, a negated “aspirin administration” means that the author positively denies that aspirin is being administered, and that he takes the same responsibility for such statement and the same requirement to have evidence for such statement than if he had not used negation. SubstanceAdministration.priorityCode categorizes the priority of a substance administration. SubstanceAdministration.doseQuantity indicates how much medication is given per dose. SubstanceAdministration.rateQuantity can be used to indicate the rate at which the dose is to be administered (e.g., the flow rate for intravenous infusions). SubstanceAdministration.maxDoseQuantity is used to capture the maximum dose of the medication that can be given over a stated time interval (e.g., maximum daily dose of morphine, maximum lifetime dose of doxorubicin). SubstanceAdministration.effectiveTime is used to describe the timing of administration. It is modeled using the GTS data type to accommodate various dosing scenarios. The capture of medication-related information also involves the interrelationship of SubstanceAdministration with several other classes. The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

Usage:

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1cs
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CDBinding: v3 Value Set ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensibleActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1cs
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CDBinding: v3 Value Set ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensibleActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1cs
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CDBinding: v3 Value Set ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensibleActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredNullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Base

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1cs
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CDBinding: v3 Value Set ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensibleActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1cs
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CDBinding: v3 Value Set ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensibleActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1csBinding: ActClass (required)
Fixed Value: SBADM
... @moodCode 1..1cs
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CDBinding: v3 Value Set ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensibleActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
SubstanceAdministration.consumable.nullFlavorrequiredNullFlavor
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Base

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel