Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: Planned Medication Activity

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.42 Version: 2.2
Active as of 2022-05-13 Computable Name: PlannedMedicationActivity
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.42:2014-06-09

This template represents planned medication activities. The priority of the medication activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the medication activity is intended to take place. The authorTime indicates when the documentation of the plan occurred.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1codeRequired Pattern: SBADM
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:extension, value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.42
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: active
... effectiveTime 1..1IVL_TSThe effectiveTime in a planned medication activity represents the time that the medication activity should occur.
... repeatNumber 0..1IVL_INTIn a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
... rateQuantity 0..1IVL_PQ
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... manufacturedProduct 1..1MedicationInformation
... performer 0..*Performer2The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
... author 0..1AuthorParticipationThe author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
... Slices for entryRelationship 0..*ElementThe following entryRelationship captures any instructions associated with the planned medication activity.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
..... typeCode 1..1codeRequired Pattern: REFR
..... observation 1..1PriorityPreference
.... entryRelationship:indication 0..*ElementThe following entryRelationship represents the indication for the planned medication activity.
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1Indication
.... entryRelationship:instruction 0..*Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... act 1..1Instruction
... precondition 0..*Precondition
.... typeCode 1..1codeRequired Pattern: PRCN
.... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:extension, value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.42
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CD​Binding: http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode (extensible)
... negationInd 0..1boolean
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSThe effectiveTime in a planned medication activity represents the time that the medication activity should occur.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1string
.... codeSystem 0..1string
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
.... value 0..1decimal
.... low 0..1PQ
.... high 0..1PQ
.... width 0..1PQ
.... center 0..1PQ
... rateQuantity 0..1IVL_PQ
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
.... value 0..1decimal
.... low 0..1PQ
.... high 0..1PQ
.... width 0..1PQ
.... center 0..1PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1MedicationInformation
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
... author 0..1AuthorParticipationThe author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... Slices for entryRelationship I0..*ElementThe following entryRelationship captures any instructions associated with the planned medication activity.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:priorityPreference I0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1PriorityPreference
.... entryRelationship:indication I0..*ElementThe following entryRelationship represents the indication for the planned medication activity.
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1Indication
.... entryRelationship:instruction I0..*Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1Instruction
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ActRelationshipType (required)
Required Pattern: PRCN
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format

Differential View

This structure is derived from CDAR2.SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1codeRequired Pattern: SBADM
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:extension, value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.42
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: active
... effectiveTime 1..1IVL_TSThe effectiveTime in a planned medication activity represents the time that the medication activity should occur.
... repeatNumber 0..1IVL_INTIn a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
... rateQuantity 0..1IVL_PQ
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... manufacturedProduct 1..1MedicationInformation
... performer 0..*Performer2The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
... author 0..1AuthorParticipationThe author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
... Slices for entryRelationship 0..*ElementThe following entryRelationship captures any instructions associated with the planned medication activity.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
..... typeCode 1..1codeRequired Pattern: REFR
..... observation 1..1PriorityPreference
.... entryRelationship:indication 0..*ElementThe following entryRelationship represents the indication for the planned medication activity.
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1Indication
.... entryRelationship:instruction 0..*Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... act 1..1Instruction
... precondition 0..*Precondition
.... typeCode 1..1codeRequired Pattern: PRCN
.... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:extension, value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.42
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CD​Binding: http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode (extensible)
... negationInd 0..1boolean
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSThe effectiveTime in a planned medication activity represents the time that the medication activity should occur.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn a Planned Medication Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1string
.... codeSystem 0..1string
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..*CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
.... value 0..1decimal
.... low 0..1PQ
.... high 0..1PQ
.... width 0..1PQ
.... center 0..1PQ
... rateQuantity 0..1IVL_PQ
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
.... value 0..1decimal
.... low 0..1PQ
.... high 0..1PQ
.... width 0..1PQ
.... center 0..1PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1MedicationInformation
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to perform the medication activity could be identified using substanceAdministration/performer.
... author 0..1AuthorParticipationThe author in a planned medication activity represents the clinician who is requesting or planning the medication activity.
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... Slices for entryRelationship I0..*ElementThe following entryRelationship captures any instructions associated with the planned medication activity.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:priorityPreference I0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the planned medication activity.
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1PriorityPreference
.... entryRelationship:indication I0..*ElementThe following entryRelationship represents the indication for the planned medication activity.
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1Indication
.... entryRelationship:instruction I0..*Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1Instruction
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ActRelationshipType (required)
Required Pattern: PRCN
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
SubstanceAdministration.templateId:primary.nullFlavorrequiredNullFlavor
SubstanceAdministration.codeextensible​http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
SubstanceAdministration.doseQuantity.nullFlavorrequiredNullFlavor
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive
SubstanceAdministration.rateQuantity.nullFlavorrequiredNullFlavor
SubstanceAdministration.rateQuantity.unitrequiredUnitsOfMeasureCaseSensitive
SubstanceAdministration.administrationUnitCoderequiredAdministrationUnitDoseForm
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
SubstanceAdministration.subject.typeCoderequiredFixed Value: SBJ
SubstanceAdministration.subject.contextControlCoderequiredFixed Value: OP
SubstanceAdministration.subject.awarenessCodeextensibleTargetAwareness
SubstanceAdministration.informant.typeCoderequiredFixed Value: INF
SubstanceAdministration.informant.contextControlCoderequiredFixed Value: OP
SubstanceAdministration.precondition.nullFlavorrequiredNullFlavor
SubstanceAdministration.precondition.typeCoderequiredPattern: PRCN

Constraints

IdGradePathDetailsRequirements
subst-er-1errorSubstanceAdministration.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:priorityPreferenceOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:instructionOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1