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

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.123 resource profile.

1. Act
Control1..1
2. Act.classCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="ACT" act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-30823).

Pattern ValueACT
3. Act.moodCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode="INT" (CONF:1098-28656).

Pattern ValueINT
4. Act.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Act.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Act.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 Act.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
7. Act.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-28657) such that it

8. Act.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. Act.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. Act.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. Act.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.123" (CONF:1098-28658).

Pattern Value2.16.840.1.113883.10.20.22.4.123
12. Act.templateId:primary.extension
Definition

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

Control0..1
Typestring
13. Act.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

14. Act.code
Control1..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-28660).

15. Act.code.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
16. Act.code.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 code SHALL contain exactly one [1..1] @code="395170001" medication monitoring (regime/therapy) (CONF:1098-30818).

Pattern Value395170001
17. Act.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1098-30819).

Pattern Value2.16.840.1.113883.6.96
18. Act.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
19. Act.code.codeSystemVersion
Definition

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

Control0..1
Typestring
20. Act.code.displayName
Definition

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

Control0..1
Typestring
21. Act.code.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
22. Act.code.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
23. Act.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
24. Act.code.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
25. Act.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
26. Act.negationInd
Control0..1
Typeboolean
27. Act.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
28. Act.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-31921).

29. Act.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
30. Act.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
BindingThe codes SHALL be taken from ActStatus
Typestring
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32358).

31. Act.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
32. Act.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
33. Act.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring
34. Act.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
35. Act.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
36. Act.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
37. Act.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
38. Act.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
39. Act.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
40. Act.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-31922).

41. Act.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
42. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
43. Act.subject
Control0..1
TypeElement
44. Act.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
45. Act.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
46. Act.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
47. Act.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
48. Act.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
49. Act.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
50. Act.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
51. Act.informant
Control0..*
TypeElement
52. Act.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
53. Act.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
54. Act.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
55. Act.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
56. Act.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Act.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
57. Act.participant:participant1
SliceNameparticipant1
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

SHALL contain at least one [1..*] participant (CONF:1098-28661) such that it

58. Act.participant:participant1.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
59. Act.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="RESP" (CONF:1098-28663).

Pattern ValueRESP
60. Act.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
61. Act.participant:participant1.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
62. Act.participant:participant1.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
63. Act.participant:participant1.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
64. Act.participant:participant1.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
65. Act.participant:participant1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
66. Act.participant:participant1.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
67. Act.participant:participant1.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1098-28662).

68. Act.participant:participant1.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="ASSIGNED" (CONF:1098-28664).

Default ValueROL
Pattern ValueASSIGNED
69. Act.participant:participant1.participantRole.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
70. Act.participant:participant1.participantRole.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

71. Act.participant:participant1.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
72. Act.participant:participant1.participantRole.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
73. Act.participant:participant1.participantRole.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
74. Act.participant:participant1.participantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
75. Act.participant:participant1.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
76. Act.participant:participant1.participantRole.playingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-28667).

77. Act.participant:participant1.participantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
Requirements

This playingEntity SHALL contain exactly one [1..1] @classCode="PSN" (CONF:1098-28668).

Default ValueENT
Pattern ValuePSN
78. Act.participant:participant1.participantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
79. Act.participant:participant1.participantRole.playingEntity.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
80. Act.participant:participant1.participantRole.playingEntity.code
Control0..1
BindingThe codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
81. Act.participant:participant1.participantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
82. Act.participant:participant1.participantRole.playingEntity.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

This playingEntity SHALL contain exactly one [1..1] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1098-28669).

InvariantsDefined on this element
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: )
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: )
83. Act.participant:participant1.participantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
84. Act.participant:participant1.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity
85. Act.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
act-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)
86. Act.entryRelationship.typeCode
Control1..1
Typecode
87. Act.entryRelationship.inversionInd
Control0..1
Typeboolean
88. Act.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
89. Act.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
90. Act.entryRelationship.negationInd
Control0..1
Typeboolean
91. Act.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
92. Act.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
93. Act.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
94. Act.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
95. Act.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
96. Act.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
97. Act.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
98. Act.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
99. Act.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
100. Act.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
101. Act.reference
Control0..*
TypeElement
102. Act.reference.typeCode
Control1..1
Typecode
103. Act.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
104. Act.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
105. Act.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
106. Act.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
107. Act.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
108. Act.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition