Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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

Draft as of 2023-09-29

Definitions for the PlannedAct logical model.

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

0. Act
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Act.classCode
Comments

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

Fixed ValueACT
4. Act.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8539).

BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
6. Act.templateId
Control1..?
SlicingThis 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
  • value @ extension
8. Act.templateId:primary
Slice Nameprimary
Comments

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

Control1..1
10. Act.templateId:primary.root
Comments

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

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.39
12. Act.templateId:primary.extension
Comments

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

Control1..?
Pattern Value2014-06-09
14. Act.id
Comments

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

Control1..?
16. Act.code
Comments

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

Invariants1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). ()
18. Act.statusCode
Comments

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

Control1..?
20. Act.statusCode.code
Comments

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

Control1..?
Fixed Valueactive
22. Act.effectiveTime
ShortThe effectiveTime in a planned act represents the time that the act should occur.
Comments

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30433).

24. Act.performer
ShortThe clinician who is expected to carry out the act could be identified using act/performer.
Comments

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

26. Act.author
ShortThe author in a planned act represents the clinician who is requesting or planning the act.
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
28. Act.entryRelationship
ShortThe following entryRelationship captures any instructions associated with the planned act.
SlicingThis 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:
  • profile @ act
30. Act.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the activity.
Comments

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

Control0..*
32. Act.entryRelationship:priorityPreference.typeCode
Comments

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

Fixed ValueREFR
34. Act.entryRelationship:priorityPreference.observation
Comments

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

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
36. Act.entryRelationship:indication
Slice Nameindication
ShortThe following entryRelationship represents the indication for the act.
Comments

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

Control0..*
38. Act.entryRelationship:indication.typeCode
Comments

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

Fixed ValueRSON
40. Act.entryRelationship:indication.observation
Comments

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

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
42. Act.entryRelationship:instruction
Slice Nameinstruction
Comments

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

Control0..*
44. Act.entryRelationship:instruction.typeCode
Comments

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

Fixed ValueSUBJ
46. Act.entryRelationship:instruction.act
Comments

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

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)

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.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-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" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8538).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueACT
4. Act.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8539).

Control1..1
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
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

Control1..*
Typehttp://hl7.org/cda/stds/core/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: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
8. Act.templateId:primary
Slice Nameprimary
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:1098-30430) such that it

Control1..1
Typehttp://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.22.4.39" (CONF:1098-30431).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.39
12. Act.templateId:primary.extension
Definition

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

Comments

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2014-06-09
14. Act.id
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Act.code
Comments

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

Control1..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
Invariants1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). ()
18. Act.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
20. 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.

Comments

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Fixed Valueactive
22. Act.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
24. Act.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
26. Act.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
28. 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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
30. Act.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
32. Act.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
34. Act.statusCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
36. Act.effectiveTime
ShortThe effectiveTime in a planned act represents the time that the act should occur.
Comments

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30433).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
38. Act.performer
ShortThe clinician who is expected to carry out the act could be identified using act/performer.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
40. Act.author
Definition

Base definition for all types defined in FHIR type system.

ShortThe author in a planned act represents the clinician who is requesting or planning the act.
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Act.entryRelationship
ShortThe following entryRelationship captures any instructions associated with the planned act.
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
SlicingThis 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:
  • profile @ act
44. Act.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the activity.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
46. Act.entryRelationship:priorityPreference.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueREFR
48. Act.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Act.entryRelationship:indication
Slice Nameindication
ShortThe following entryRelationship represents the indication for the act.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
52. Act.entryRelationship:indication.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueRSON
54. Act.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Act.entryRelationship:instruction
Slice Nameinstruction
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
58. Act.entryRelationship:instruction.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSUBJ
60. Act.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. Act.classCode
Definition

Element Act.classCode

Comments

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueACT
6. Act.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8539).

Control1..1
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
8. Act.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. Act.typeId
Control0..1
Typehttp://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

Control1..*
Typehttp://hl7.org/cda/stds/core/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: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
14. Act.templateId:primary
Slice Nameprimary
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:1098-30430) such that it

Control1..1
Typehttp://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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning 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).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
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.22.4.39" (CONF:1098-30431).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.39
24. Act.templateId:primary.extension
Definition

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

Comments

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2014-06-09
26. Act.id
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
28. Act.code
Comments

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

Control1..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
Invariants1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). ()
30. Act.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
32. Act.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
34. Act.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
36. 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(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
38. 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.

Comments

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Fixed Valueactive
40. Act.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
42. Act.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
44. Act.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
46. 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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
48. 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(oid: ISO Object Identifier)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
50. 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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
52. Act.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
54. Act.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
56. Act.statusCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
58. Act.effectiveTime
ShortThe effectiveTime in a planned act represents the time that the act should occur.
Comments

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30433).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
60. Act.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
62. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
64. Act.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
66. Act.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
68. Act.performer
ShortThe clinician who is expected to carry out the act could be identified using act/performer.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
70. Act.author
Definition

Base definition for all types defined in FHIR type system.

ShortThe author in a planned act represents the clinician who is requesting or planning the act.
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Act.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
74. Act.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
76. Act.entryRelationship
ShortThe following entryRelationship captures any instructions associated with the planned act.
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
SlicingThis 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:
  • profile @ act
78. Act.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the activity.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
80. Act.entryRelationship:priorityPreference.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(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
82. Act.entryRelationship:priorityPreference.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/cda/stds/core/StructureDefinition/CS
84. Act.entryRelationship:priorityPreference.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/cda/stds/core/StructureDefinition/II
86. Act.entryRelationship:priorityPreference.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/cda/stds/core/StructureDefinition/II
88. Act.entryRelationship:priorityPreference.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueREFR
90. Act.entryRelationship:priorityPreference.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.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
92. Act.entryRelationship:priorityPreference.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.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
94. Act.entryRelationship:priorityPreference.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
96. Act.entryRelationship:priorityPreference.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
98. Act.entryRelationship:priorityPreference.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
100. Act.entryRelationship:priorityPreference.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
102. Act.entryRelationship:priorityPreference.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
104. Act.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Act.entryRelationship:priorityPreference.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
108. Act.entryRelationship:priorityPreference.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
110. Act.entryRelationship:priorityPreference.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
112. Act.entryRelationship:priorityPreference.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
114. Act.entryRelationship:priorityPreference.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
116. Act.entryRelationship:priorityPreference.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
118. Act.entryRelationship:indication
Slice Nameindication
ShortThe following entryRelationship represents the indication for the act.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
120. Act.entryRelationship:indication.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(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
122. Act.entryRelationship:indication.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/cda/stds/core/StructureDefinition/CS
124. Act.entryRelationship:indication.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/cda/stds/core/StructureDefinition/II
126. Act.entryRelationship:indication.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/cda/stds/core/StructureDefinition/II
128. Act.entryRelationship:indication.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueRSON
130. Act.entryRelationship:indication.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.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
132. Act.entryRelationship:indication.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.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
134. Act.entryRelationship:indication.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
136. Act.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
138. Act.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
140. Act.entryRelationship:indication.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
142. Act.entryRelationship:indication.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
144. Act.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. Act.entryRelationship:indication.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
148. Act.entryRelationship:indication.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
150. Act.entryRelationship:indication.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
152. Act.entryRelationship:indication.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
154. Act.entryRelationship:indication.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
156. Act.entryRelationship:indication.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
158. Act.entryRelationship:instruction
Slice Nameinstruction
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
160. Act.entryRelationship:instruction.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(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
162. Act.entryRelationship:instruction.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/cda/stds/core/StructureDefinition/CS
164. Act.entryRelationship:instruction.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/cda/stds/core/StructureDefinition/II
166. Act.entryRelationship:instruction.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/cda/stds/core/StructureDefinition/II
168. Act.entryRelationship:instruction.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSUBJ
170. Act.entryRelationship:instruction.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.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
172. Act.entryRelationship:instruction.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.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
174. Act.entryRelationship:instruction.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
176. Act.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
178. Act.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
180. Act.entryRelationship:instruction.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
182. Act.entryRelationship:instruction.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
184. Act.entryRelationship:instruction.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
186. Act.entryRelationship:instruction.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
188. Act.entryRelationship:instruction.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
190. Act.entryRelationship:instruction.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
192. Act.entryRelationship:instruction.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
194. Act.entryRelationship:instruction.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
196. Act.entryRelationship:instruction.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
198. Act.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
200. Act.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition