Authorization Activity - Definitions - Consolidated CDA Release 2.1 StructureDefinition Publication v2.1

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

Logical Model: AuthorizationActivity - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the AuthorizationActivity logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. Act
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Act.classCode
Comments	SHALL contain exactly one [1..1] @classCode="ACT" Act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8944).
Fixed Value	ACT
4. Act.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8945).
Fixed Value	EVN
6. Act.templateId
Control	1..?
Slicing	This element introduces a set of slices on `Act.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
8. Act.templateId:primary
Slice Name	primary
Comments	SHALL contain exactly one [1..1] templateId (CONF:81-8946) such that it, SHALL not contain [0..0] extension.
Control	1..1
10. Act.templateId:primary.root
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.1.19" (CONF:81-10529).
Control	1..?
Pattern Value	2.16.840.1.113883.10.20.1.19
12. Act.templateId:primary.extension
Control	0..0
14. Act.id
Comments	SHALL contain exactly one [1..1] id (CONF:81-8947).
Control	1..1
16. Act.entryRelationship
Control	1..?
Slicing	This element introduces a set of slices on `Act.entryRelationship`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ typeCode
18. Act.entryRelationship:target
Slice Name	target
Comments	SHALL contain at least one [1..*] entryRelationship (CONF:81-8948) such that it
Control	1..*
Invariants	81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). (`act or observation or procedure or substanceAdministration or supply`) 81-8952: The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). ()
20. Act.entryRelationship:target.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-8949).
Fixed Value	SUBJ

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

0. Act
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Act.classCode
Definition	Element Act.classCode
Comments	SHALL contain exactly one [1..1] @classCode="ACT" Act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8944).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	ACT
4. Act.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8945).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	EVN
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
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Act.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
8. Act.templateId:primary
Slice Name	primary
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
Comments	SHALL contain exactly one [1..1] templateId (CONF:81-8946) such that it, SHALL not contain [0..0] extension.
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
10. 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.
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.1.19" (CONF:81-10529).
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	2.16.840.1.113883.10.20.1.19
12. Act.templateId:primary.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	0..0
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
14. Act.id
Comments	SHALL contain exactly one [1..1] id (CONF:81-8947).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. Act.code
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
18. Act.entryRelationship
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing	This element introduces a set of slices on `Act.entryRelationship`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ typeCode
20. Act.entryRelationship:target
Slice Name	target
Comments	SHALL contain at least one [1..*] entryRelationship (CONF:81-8948) such that it
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Invariants	81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). (`act or observation or procedure or substanceAdministration or supply`) 81-8952: The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). ()
22. Act.entryRelationship:target.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-8949).
Control	1..1
Binding	The codes SHALL be taken from x_ActRelationshipEntryRelationship
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	SUBJ

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

0. Act
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. Act.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. Act.classCode
Definition	Element Act.classCode
Comments	SHALL contain exactly one [1..1] @classCode="ACT" Act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8944).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	ACT
6. Act.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8945).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	EVN
8. Act.realmCode
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
10. Act.typeId
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
12. 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
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Act.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root
14. Act.templateId:primary
Slice Name	primary
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
Comments	SHALL contain exactly one [1..1] templateId (CONF:81-8946) such that it, SHALL not contain [0..0] extension.
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. 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.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
18. 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.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
20. 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).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
22. 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.
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.1.19" (CONF:81-10529).
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	2.16.840.1.113883.10.20.1.19
24. Act.templateId:primary.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	0..0
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
26. Act.id
Comments	SHALL contain exactly one [1..1] id (CONF:81-8947).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
28. Act.code
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
30. Act.negationInd
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
32. Act.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
34. Act.statusCode
Control	0..1
Binding	The codes SHALL be taken from ActStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
36. Act.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
38. Act.priorityCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from ActPriority
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
40. Act.languageCode
Control	0..1
Binding	The codes SHALL be taken from HumanLanguage
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
42. Act.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
44. Act.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
46. Act.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
48. Act.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
50. Act.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
52. Act.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
54. Act.entryRelationship
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing	This element introduces a set of slices on `Act.entryRelationship`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ typeCode
56. Act.entryRelationship:target
Slice Name	target
Comments	SHALL contain at least one [1..*] entryRelationship (CONF:81-8948) such that it
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Invariants	81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). (`act or observation or procedure or substanceAdministration or supply`) 81-8952: The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). ()
58. Act.entryRelationship:target.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
60. Act.entryRelationship:target.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
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
62. Act.entryRelationship:target.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.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
64. Act.entryRelationship:target.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
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
66. Act.entryRelationship:target.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-8949).
Control	1..1
Binding	The codes SHALL be taken from x_ActRelationshipEntryRelationship
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	SUBJ
68. Act.entryRelationship:target.inversionInd
Definition	The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
70. Act.entryRelationship:target.contextConductionInd
Definition	The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	true
72. Act.entryRelationship:target.negationInd
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
74. Act.entryRelationship:target.sequenceNumber
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
76. Act.entryRelationship:target.seperatableInd
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/BL
78. Act.entryRelationship:target.act
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Act
80. Act.entryRelationship:target.encounter
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Encounter
82. Act.entryRelationship:target.observation
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Observation
84. Act.entryRelationship:target.observationMedia
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
86. Act.entryRelationship:target.organizer
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Organizer
88. Act.entryRelationship:target.procedure
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Procedure
90. Act.entryRelationship:target.regionOfInterest
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
92. Act.entryRelationship:target.substanceAdministration
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
94. Act.entryRelationship:target.supply
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Supply
96. Act.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
98. Act.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition