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: PlannedMedicationActivity - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.42 resource profile.

1. SubstanceAdministration
Control1..1
2. SubstanceAdministration.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="SBADM" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8572).

Default ValueSBADM
Fixed ValueSBADM
Pattern ValueSBADM
3. SubstanceAdministration.moodCode
Control1..1
BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply)
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8573).

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
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ extension
  • ,
  • value @ root
7. SubstanceAdministration.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-30465) such that it

8. SubstanceAdministration.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
9. SubstanceAdministration.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
10. SubstanceAdministration.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
11. SubstanceAdministration.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.42" (CONF:1098-30466).

Pattern Value2.16.840.1.113883.10.20.22.4.42
12. SubstanceAdministration.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32557).

Pattern Value2014-06-09
13. SubstanceAdministration.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8575).

14. SubstanceAdministration.code
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
15. SubstanceAdministration.negationInd
Control0..1
Typeboolean
16. SubstanceAdministration.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
17. SubstanceAdministration.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-32087).

18. SubstanceAdministration.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
19. SubstanceAdministration.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32088).

Pattern Valueactive
20. SubstanceAdministration.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
21. SubstanceAdministration.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
22. SubstanceAdministration.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
23. SubstanceAdministration.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
24. SubstanceAdministration.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
25. SubstanceAdministration.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
26. SubstanceAdministration.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
27. SubstanceAdministration.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
28. SubstanceAdministration.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
29. SubstanceAdministration.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-30468) such that it

30. 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
31. SubstanceAdministration.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
Requirements

MAY contain zero or one [0..1] repeatNumber (CONF:1098-32066).

32. SubstanceAdministration.routeCode
Control0..1
BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32067).

33. SubstanceAdministration.routeCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
34. SubstanceAdministration.routeCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control0..1
Typestring
35. SubstanceAdministration.routeCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
36. SubstanceAdministration.routeCode.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
37. SubstanceAdministration.routeCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
38. SubstanceAdministration.routeCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring
39. SubstanceAdministration.routeCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
40. SubstanceAdministration.routeCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
41. SubstanceAdministration.routeCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
42. SubstanceAdministration.routeCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
43. SubstanceAdministration.routeCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
BindingThe codes SHALL be taken from Medication Route
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32952).

44. SubstanceAdministration.approachSiteCode
Control0..*
BindingThe codes SHALL be taken from Body Site Value Set
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32078).

45. SubstanceAdministration.doseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
Requirements

MAY contain zero or one [0..1] doseQuantity (CONF:1098-32068).

46. SubstanceAdministration.doseQuantity.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
47. SubstanceAdministration.doseQuantity.unit
Definition

The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

Control0..1
BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
Typecode
Requirements

The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32133).

48. SubstanceAdministration.doseQuantity.value
Definition

The magnitude of the quantity measured in terms of the unit.

Control0..1
Typedecimal
49. SubstanceAdministration.doseQuantity.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
50. SubstanceAdministration.doseQuantity.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
51. SubstanceAdministration.doseQuantity.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
52. SubstanceAdministration.doseQuantity.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
53. SubstanceAdministration.rateQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-PQ
Requirements

MAY contain zero or one [0..1] rateQuantity (CONF:1098-32079).

54. SubstanceAdministration.rateQuantity.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
55. SubstanceAdministration.rateQuantity.unit
Definition

The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

Control0..1
BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
Typecode
Requirements

The rateQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32134).

56. SubstanceAdministration.rateQuantity.value
Definition

The magnitude of the quantity measured in terms of the unit.

Control0..1
Typedecimal
57. SubstanceAdministration.rateQuantity.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
58. SubstanceAdministration.rateQuantity.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
59. SubstanceAdministration.rateQuantity.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
60. SubstanceAdministration.rateQuantity.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
61. SubstanceAdministration.maxDoseQuantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ
Requirements

MAY contain zero or one [0..1] maxDoseQuantity (CONF:1098-32080).

62. SubstanceAdministration.administrationUnitCode
Control0..1
BindingThe codes SHALL be taken from AdministrationUnitDoseForm
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

MAY contain zero or one [0..1] administrationUnitCode, which SHALL be selected from ValueSet AdministrationUnitDoseForm urn:oid:2.16.840.1.113762.1.4.1021.30 DYNAMIC (CONF:1098-32081).

63. SubstanceAdministration.consumable
Control1..1
TypeElement
Requirements

SHALL contain exactly one [1..1] consumable (CONF:1098-32082).

64. SubstanceAdministration.consumable.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
Default ValueCSM
Fixed ValueCSM
65. SubstanceAdministration.consumable.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation)
Requirements

This consumable SHALL contain exactly one [1..1] Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-32083).

66. SubstanceAdministration.subject
Control0..1
TypeElement
67. SubstanceAdministration.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
68. SubstanceAdministration.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
69. 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
70. SubstanceAdministration.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
71. SubstanceAdministration.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
72. SubstanceAdministration.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-30470).

73. SubstanceAdministration.author
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32046).

74. SubstanceAdministration.informant
Control0..*
TypeElement
75. SubstanceAdministration.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
76. SubstanceAdministration.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
77. SubstanceAdministration.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
78. SubstanceAdministration.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
79. SubstanceAdministration.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
80. SubstanceAdministration.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
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)
SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ act
  • ,
  • profile @ observation
81. SubstanceAdministration.entryRelationship.typeCode
Control1..1
Typecode
82. SubstanceAdministration.entryRelationship.inversionInd
Control0..1
Typeboolean
83. SubstanceAdministration.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
84. SubstanceAdministration.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
85. SubstanceAdministration.entryRelationship.negationInd
Control0..1
Typeboolean
86. SubstanceAdministration.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
87. SubstanceAdministration.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
88. SubstanceAdministration.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
89. SubstanceAdministration.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
90. SubstanceAdministration.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
91. SubstanceAdministration.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
92. SubstanceAdministration.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
93. SubstanceAdministration.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
94. SubstanceAdministration.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
95. SubstanceAdministration.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
96. SubstanceAdministration.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-31104) such that it

InvariantsDefined on this element
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)
97. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31105).

Pattern ValueREFR
98. SubstanceAdministration.entryRelationship:priorityPreference.inversionInd
Control0..1
Typeboolean
99. SubstanceAdministration.entryRelationship:priorityPreference.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
100. SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
101. SubstanceAdministration.entryRelationship:priorityPreference.negationInd
Control0..1
Typeboolean
102. SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
103. SubstanceAdministration.entryRelationship:priorityPreference.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31106).

104. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
105. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
106. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
107. SubstanceAdministration.entryRelationship:priorityPreference.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
108. SubstanceAdministration.entryRelationship:priorityPreference.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
109. SubstanceAdministration.entryRelationship:priorityPreference.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
110. SubstanceAdministration.entryRelationship:priorityPreference.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
111. SubstanceAdministration.entryRelationship:priorityPreference.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
112. SubstanceAdministration.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32069) such that it

InvariantsDefined on this element
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)
113. SubstanceAdministration.entryRelationship:indication.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32070).

Pattern ValueRSON
114. SubstanceAdministration.entryRelationship:indication.inversionInd
Control0..1
Typeboolean
115. SubstanceAdministration.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
116. SubstanceAdministration.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
117. SubstanceAdministration.entryRelationship:indication.negationInd
Control0..1
Typeboolean
118. SubstanceAdministration.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
119. SubstanceAdministration.entryRelationship:indication.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32071).

120. SubstanceAdministration.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
121. SubstanceAdministration.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
122. SubstanceAdministration.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
123. SubstanceAdministration.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
124. SubstanceAdministration.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
125. SubstanceAdministration.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
126. SubstanceAdministration.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
127. SubstanceAdministration.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
128. SubstanceAdministration.entryRelationship:instruction
SliceNameinstruction
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-32072) such that it

InvariantsDefined on this element
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)
129. SubstanceAdministration.entryRelationship:instruction.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32073).

Pattern ValueSUBJ
130. SubstanceAdministration.entryRelationship:instruction.inversionInd
Control0..1
Typeboolean
131. SubstanceAdministration.entryRelationship:instruction.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
132. SubstanceAdministration.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
133. SubstanceAdministration.entryRelationship:instruction.negationInd
Control0..1
Typeboolean
134. SubstanceAdministration.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
135. SubstanceAdministration.entryRelationship:instruction.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
136. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
137. SubstanceAdministration.entryRelationship:instruction.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
138. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
139. SubstanceAdministration.entryRelationship:instruction.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
140. SubstanceAdministration.entryRelationship:instruction.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
141. SubstanceAdministration.entryRelationship:instruction.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
142. SubstanceAdministration.entryRelationship:instruction.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
143. SubstanceAdministration.entryRelationship:instruction.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32074).

144. SubstanceAdministration.reference
Control0..*
TypeElement
145. SubstanceAdministration.reference.typeCode
Control1..1
Typecode
146. SubstanceAdministration.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
147. SubstanceAdministration.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
148. SubstanceAdministration.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
149. SubstanceAdministration.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
150. SubstanceAdministration.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
151. SubstanceAdministration.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
Requirements

MAY contain zero or more [0..*] precondition (CONF:1098-32084).

152. SubstanceAdministration.precondition.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
153. SubstanceAdministration.precondition.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipType
Typecode
Requirements

The precondition, if present, SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32085).

Pattern ValuePRCN
154. SubstanceAdministration.precondition.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
155. SubstanceAdministration.precondition.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
156. SubstanceAdministration.precondition.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
157. SubstanceAdministration.precondition.criterion
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Criterion(PreconditionforSubstanceAdministration)
Requirements

The precondition, if present, SHALL contain exactly one [1..1] Precondition for Substance Administration (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32086).