Consolidated CDA Release 2.2
2.2 - CI Build Unknown state code 'US'

Consolidated CDA Release 2.2 - Local Development build (v2.2). See the Directory of published versions

Resource Profile: PlannedMedicationActivity - Detailed Descriptions

Active as of 2023-05-30

Definitions for the 2.16.840.1.113883.10.20.22.4.42 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. SubstanceAdministration

Guidance on how to interpret the contents of this table can be found here.

1. SubstanceAdministration
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
2. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBADM
Fixed ValueSBADM
3. SubstanceAdministration.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. SubstanceAdministration.consumable
Control1..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. SubstanceAdministration.consumable.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCSM
Fixed ValueCSM
6. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct

Guidance on how to interpret the contents of this table can be found here.

1. SubstanceAdministration
Definition

Base definition for all types defined in FHIR type system.

Control1..1
2. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBADM
Fixed ValueSBADM
3. SubstanceAdministration.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. SubstanceAdministration.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. SubstanceAdministration.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. SubstanceAdministration.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
7. SubstanceAdministration.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
8. SubstanceAdministration.code
Control0..1
BindingThe codes SHALL be taken from ActSubstanceAdministrationCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
9. SubstanceAdministration.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
10. SubstanceAdministration.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
11. SubstanceAdministration.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
12. SubstanceAdministration.effectiveTime
Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXCM-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
13. SubstanceAdministration.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
14. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
15. SubstanceAdministration.routeCode
Control0..1
BindingThe codes SHALL be taken from RouteOfAdministration; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
16. SubstanceAdministration.approachSiteCode
Control0..*
BindingThe codes SHALL be taken from v3 Code System ActSite; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
17. SubstanceAdministration.doseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
18. SubstanceAdministration.rateQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
19. SubstanceAdministration.maxDoseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ
20. SubstanceAdministration.administrationUnitCode
Control0..1
BindingThe codes SHALL be taken from AdministrableDrugForm; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
21. SubstanceAdministration.consumable
Control1..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. SubstanceAdministration.consumable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
23. SubstanceAdministration.consumable.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.consumable.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. SubstanceAdministration.consumable.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCSM
Fixed ValueCSM
25. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct
26. SubstanceAdministration.subject
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. SubstanceAdministration.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
28. SubstanceAdministration.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
29. SubstanceAdministration.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
30. SubstanceAdministration.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
31. SubstanceAdministration.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
32. SubstanceAdministration.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
33. SubstanceAdministration.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
34. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
35. SubstanceAdministration.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
36. SubstanceAdministration.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. SubstanceAdministration.informant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
38. SubstanceAdministration.informant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
39. SubstanceAdministration.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINF
Fixed ValueINF
40. SubstanceAdministration.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
41. SubstanceAdministration.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
42. SubstanceAdministration.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
43. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
44. SubstanceAdministration.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
subst-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
45. SubstanceAdministration.entryRelationship.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
46. SubstanceAdministration.entryRelationship.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
47. SubstanceAdministration.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
48. SubstanceAdministration.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
49. SubstanceAdministration.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
50. SubstanceAdministration.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
51. SubstanceAdministration.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
52. SubstanceAdministration.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
53. SubstanceAdministration.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
54. SubstanceAdministration.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
55. SubstanceAdministration.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
56. SubstanceAdministration.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
57. SubstanceAdministration.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
58. SubstanceAdministration.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
59. SubstanceAdministration.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
60. SubstanceAdministration.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
61. SubstanceAdministration.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
62. SubstanceAdministration.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. SubstanceAdministration.reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
64. SubstanceAdministration.reference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SubstanceAdministration.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
65. SubstanceAdministration.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
66. SubstanceAdministration.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
67. SubstanceAdministration.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
68. SubstanceAdministration.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
69. SubstanceAdministration.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
70. SubstanceAdministration.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
71. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition