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

Draft as of 2023-09-29

Definitions for the InterventionAct 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) (CONF:1198-30971).

Fixed ValueACT
4. Act.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-30972).

Fixed ValueEVN
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:1198-30973) 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.131" (CONF:1198-30974).

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

SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32916).

Control1..?
Pattern Value2015-08-01
14. Act.id
Comments

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

Control1..?
16. Act.code
Comments

SHALL contain exactly one [1..1] code (CONF:1198-30976).

18. Act.code.code
Comments

This code SHALL contain exactly one [1..1] @code="362956003" procedure / intervention (navigational concept) (CONF:1198-30977).

Control1..?
Pattern Value362956003
20. Act.code.codeSystem
Comments

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:1198-30978).

Control1..?
Pattern Value2.16.840.1.113883.6.96
22. Act.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1198-30979).

Control1..?
24. Act.statusCode.code
Comments

This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-32316).

Control1..?
Fixed Valuecompleted
26. Act.effectiveTime
Comments

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

28. Act.author
Comments

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31552).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
30. Act.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 @ observation
  • profile @ substanceAdministration
  • profile @ act
  • profile @ procedure
  • profile @ encounter
  • profile @ supply
32. Act.entryRelationship:advanceDirectiveObservation
Slice NameadvanceDirectiveObservation
Comments

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

Control0..*
34. Act.entryRelationship:advanceDirectiveObservation.typeCode
Comments

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

Fixed ValueREFR
36. Act.entryRelationship:advanceDirectiveObservation.observation
Comments

SHALL contain exactly one [1..1] Advance Directive Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.48:2015-08-01) (CONF:1198-30982).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Advance Directive Observation)
38. Act.entryRelationship:immunizationActivity
Slice NameimmunizationActivity
Comments

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

Control0..*
40. Act.entryRelationship:immunizationActivity.typeCode
Comments

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

Fixed ValueREFR
42. Act.entryRelationship:immunizationActivity.substanceAdministration
Comments

SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-30986).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Immunization Activity)
44. Act.entryRelationship:medicationActivity
Slice NamemedicationActivity
Comments

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

Control0..*
46. Act.entryRelationship:medicationActivity.typeCode
Comments

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

Fixed ValueREFR
48. Act.entryRelationship:medicationActivity.substanceAdministration
Comments

SHALL contain exactly one [1..1] Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1198-30990).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Medication Activity)
50. Act.entryRelationship:interventionAct
Slice NameinterventionAct
ShortThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
Comments

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

Control0..*
52. Act.entryRelationship:interventionAct.typeCode
Comments

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

Fixed ValueREFR
54. Act.entryRelationship:interventionAct.act
Comments

SHALL contain exactly one [1..1] Intervention Act (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.131:2015-08-01) (CONF:1198-32460).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Intervention Act)
56. Act.entryRelationship:procedureActivityProcedure
Slice NameprocedureActivityProcedure
Comments

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

Control0..*
58. Act.entryRelationship:procedureActivityProcedure.typeCode
Comments

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

Fixed ValueREFR
60. Act.entryRelationship:procedureActivityProcedure.procedure
Comments

SHALL contain exactly one [1..1] Procedure Activity Procedure (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.14:2014-06-09) (CONF:1198-31170).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure(Procedure Activity Procedure)
62. Act.entryRelationship:encounterActivity
Slice NameencounterActivity
Comments

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

Control0..*
64. Act.entryRelationship:encounterActivity.typeCode
Comments

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

Fixed ValueREFR
66. Act.entryRelationship:encounterActivity.encounter
Comments

SHALL contain exactly one [1..1] Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:1198-31173).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter(Encounter Activity)
68. Act.entryRelationship:instruction
Slice Nameinstruction
Comments

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

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

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

Fixed ValueREFR
72. 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:1198-31176).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
74. Act.entryRelationship:nonMedSupply
Slice NamenonMedSupply
Comments

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

Control0..*
76. Act.entryRelationship:nonMedSupply.typeCode
Comments

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

Fixed ValueREFR
78. Act.entryRelationship:nonMedSupply.supply
Comments

SHALL contain exactly one [1..1] Non-Medicinal Supply Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.50:2014-06-09) (CONF:1198-31179).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Non-Medicinal Supply Activity)
80. Act.entryRelationship:nutritionRecommendation
Slice NamenutritionRecommendation
Comments

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

Control0..*
82. Act.entryRelationship:nutritionRecommendation.act
Comments

SHALL contain exactly one [1..1] Nutrition Recommendation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.130) (CONF:1198-31414).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Nutrition Recommendation)
84. Act.entryRelationship:entryReferenceRefr
Slice NameentryReferenceRefr
ShortWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
Comments

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

Control0..*
86. Act.entryRelationship:entryReferenceRefr.typeCode
Comments

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

Fixed ValueREFR
88. Act.entryRelationship:entryReferenceRefr.act
Comments

SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-31555).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
90. Act.entryRelationship:entryReferenceRson
Slice NameentryReferenceRson
ShortAn Intervention Act should reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
Comments

SHOULD contain zero or more [0..*] entryRelationship (CONF:1198-31621) such that it

Control0..*
Invariants1198-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459). ()
92. Act.entryRelationship:entryReferenceRson.typeCode
Comments

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

Fixed ValueRSON
94. Act.entryRelationship:entryReferenceRson.act
Comments

SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-31623).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
96. Act.entryRelationship:handoffCommunicationParticipants
Slice NamehandoffCommunicationParticipants
Comments

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

Control0..*
98. Act.entryRelationship:handoffCommunicationParticipants.typeCode
Comments

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

Fixed ValueREFR
100. Act.entryRelationship:handoffCommunicationParticipants.act
Comments

SHALL contain exactly one [1..1] Handoff Communication Participants (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.141) (CONF:1198-32319).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Handoff Communication Participants)
102. Act.entryRelationship:plannedInterventionAct
Slice NameplannedInterventionAct
Comments

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

Control0..*
104. Act.entryRelationship:plannedInterventionAct.typeCode
Comments

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

Fixed ValueREFR
106. Act.entryRelationship:plannedInterventionAct.act
Comments

SHALL contain exactly one [1..1] Planned Intervention Act (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.146:2015-08-01) (CONF:1198-32915).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Planned Intervention Act)
108. Act.reference
Comments

MAY contain zero or more [0..*] reference (CONF:1198-32760).

110. Act.reference.typeCode
Comments

The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32761).

Fixed ValueREFR
112. Act.reference.externalDocument
Comments

The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1198-32762).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument(External Document Reference)

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) (CONF:1198-30971).

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="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-30972).

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 ValueEVN
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:1198-30973) 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.131" (CONF:1198-30974).

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.131
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="2015-08-01" (CONF:1198-32916).

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 Value2015-08-01
14. Act.id
Comments

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

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

SHALL contain exactly one [1..1] code (CONF:1198-30976).

Control1..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
18. 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.

Comments

This code SHALL contain exactly one [1..1] @code="362956003" procedure / intervention (navigational concept) (CONF:1198-30977).

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
Pattern Value362956003
20. Act.code.codeSystem
Definition

Specifies the code system that defines the code.

Comments

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:1198-30978).

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.
LabelCode System
Pattern Value2.16.840.1.113883.6.96
22. Act.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1198-30979).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
24. 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="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-32316).

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 Valuecompleted
26. 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
28. 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
30. 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
32. 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
34. 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
36. 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
38. 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
40. Act.effectiveTime
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
42. Act.author
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31552).

Control0..*
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()))
44. Act.entryRelationship
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 @ observation
  • profile @ substanceAdministration
  • profile @ act
  • profile @ procedure
  • profile @ encounter
  • profile @ supply
46. Act.entryRelationship:advanceDirectiveObservation
Slice NameadvanceDirectiveObservation
Comments

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

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

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

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
50. Act.entryRelationship:advanceDirectiveObservation.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] Advance Directive Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.48:2015-08-01) (CONF:1198-30982).

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

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

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

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

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
56. Act.entryRelationship:immunizationActivity.substanceAdministration
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-30986).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Immunization Activity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Act.entryRelationship:medicationActivity
Slice NamemedicationActivity
Comments

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

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

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

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
62. Act.entryRelationship:medicationActivity.substanceAdministration
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1198-30990).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Medication Activity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1098-30800: Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). ()
64. Act.entryRelationship:interventionAct
Slice NameinterventionAct
ShortThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
Comments

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

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

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

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
68. Act.entryRelationship:interventionAct.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] Intervention Act (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.131:2015-08-01) (CONF:1198-32460).

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

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

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

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

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
74. Act.entryRelationship:procedureActivityProcedure.procedure
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Procedure Activity Procedure (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.14:2014-06-09) (CONF:1198-31170).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure(Procedure Activity Procedure)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Act.entryRelationship:encounterActivity
Slice NameencounterActivity
Comments

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

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

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

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
80. Act.entryRelationship:encounterActivity.encounter
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:1198-31173).

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

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

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

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

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
86. 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:1198-31176).

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()))
88. Act.entryRelationship:nonMedSupply
Slice NamenonMedSupply
Comments

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

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

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

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
92. Act.entryRelationship:nonMedSupply.supply
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Non-Medicinal Supply Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.50:2014-06-09) (CONF:1198-31179).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Non-Medicinal Supply Activity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Act.entryRelationship:nutritionRecommendation
Slice NamenutritionRecommendation
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
96. Act.entryRelationship:nutritionRecommendation.typeCode
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.
98. Act.entryRelationship:nutritionRecommendation.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] Nutrition Recommendation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.130) (CONF:1198-31414).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Nutrition Recommendation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Act.entryRelationship:entryReferenceRefr
Slice NameentryReferenceRefr
ShortWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
Comments

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

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

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

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
104. Act.entryRelationship:entryReferenceRefr.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-31555).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Act.entryRelationship:entryReferenceRson
Slice NameentryReferenceRson
ShortAn Intervention Act should reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
Comments

SHOULD contain zero or more [0..*] entryRelationship (CONF:1198-31621) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Invariants1198-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459). ()
108. Act.entryRelationship:entryReferenceRson.typeCode
Comments

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

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
110. Act.entryRelationship:entryReferenceRson.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-31623).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Act.entryRelationship:handoffCommunicationParticipants
Slice NamehandoffCommunicationParticipants
Comments

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

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

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

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
116. Act.entryRelationship:handoffCommunicationParticipants.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] Handoff Communication Participants (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.141) (CONF:1198-32319).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Handoff Communication Participants)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Act.entryRelationship:plannedInterventionAct
Slice NameplannedInterventionAct
Comments

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

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

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

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
122. Act.entryRelationship:plannedInterventionAct.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] Planned Intervention Act (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.146:2015-08-01) (CONF:1198-32915).

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

MAY contain zero or more [0..*] reference (CONF:1198-32760).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
126. Act.reference.typeCode
Definition

Element Act.typeCode

Comments

The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32761).

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipExternalReference
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
128. Act.reference.externalDocument
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1198-32762).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument(External Document Reference)
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) (CONF:1198-30971).

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="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-30972).

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 ValueEVN
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:1198-30973) 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.131" (CONF:1198-30974).

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.131
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="2015-08-01" (CONF:1198-32916).

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 Value2015-08-01
26. Act.id
Comments

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

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

SHALL contain exactly one [1..1] code (CONF:1198-30976).

Control1..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
30. 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(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
32. 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.

Comments

This code SHALL contain exactly one [1..1] @code="362956003" procedure / intervention (navigational concept) (CONF:1198-30977).

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
Pattern Value362956003
34. Act.code.codeSystem
Definition

Specifies the code system that defines the code.

Comments

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:1198-30978).

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.
LabelCode System
Pattern Value2.16.840.1.113883.6.96
36. Act.code.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
38. Act.code.codeSystemVersion
Definition

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

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.
LabelCode System Version
40. 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(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
42. 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(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.
44. 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(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.
46. Act.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
48. Act.code.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
50. Act.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
52. 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.
54. Act.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
56. Act.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1198-30979).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
58. 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
60. 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="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-32316).

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 Valuecompleted
62. 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
64. 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
66. 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
68. 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
70. 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.
72. 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.
74. 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
76. 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
78. 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
80. Act.effectiveTime
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
82. Act.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
84. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
86. Act.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
88. Act.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
90. Act.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
92. Act.author
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-31552).

Control0..*
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()))
94. Act.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
96. Act.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
98. Act.entryRelationship
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 @ observation
  • profile @ substanceAdministration
  • profile @ act
  • profile @ procedure
  • profile @ encounter
  • profile @ supply
100. Act.entryRelationship:advanceDirectiveObservation
Slice NameadvanceDirectiveObservation
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
102. Act.entryRelationship:advanceDirectiveObservation.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
104. Act.entryRelationship:advanceDirectiveObservation.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
106. Act.entryRelationship:advanceDirectiveObservation.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
108. Act.entryRelationship:advanceDirectiveObservation.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
110. Act.entryRelationship:advanceDirectiveObservation.typeCode
Comments

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

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
112. Act.entryRelationship:advanceDirectiveObservation.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.
114. Act.entryRelationship:advanceDirectiveObservation.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
116. Act.entryRelationship:advanceDirectiveObservation.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.
118. Act.entryRelationship:advanceDirectiveObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
120. Act.entryRelationship:advanceDirectiveObservation.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
122. Act.entryRelationship:advanceDirectiveObservation.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
124. Act.entryRelationship:advanceDirectiveObservation.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
126. Act.entryRelationship:advanceDirectiveObservation.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] Advance Directive Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.48:2015-08-01) (CONF:1198-30982).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Advance Directive Observation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. Act.entryRelationship:advanceDirectiveObservation.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
130. Act.entryRelationship:advanceDirectiveObservation.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
132. Act.entryRelationship:advanceDirectiveObservation.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
134. Act.entryRelationship:advanceDirectiveObservation.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
136. Act.entryRelationship:advanceDirectiveObservation.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
138. Act.entryRelationship:advanceDirectiveObservation.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
140. Act.entryRelationship:immunizationActivity
Slice NameimmunizationActivity
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
142. Act.entryRelationship:immunizationActivity.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
144. Act.entryRelationship:immunizationActivity.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
146. Act.entryRelationship:immunizationActivity.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
148. Act.entryRelationship:immunizationActivity.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
150. Act.entryRelationship:immunizationActivity.typeCode
Comments

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

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
152. Act.entryRelationship:immunizationActivity.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.
154. Act.entryRelationship:immunizationActivity.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
156. Act.entryRelationship:immunizationActivity.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.
158. Act.entryRelationship:immunizationActivity.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
160. Act.entryRelationship:immunizationActivity.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
162. Act.entryRelationship:immunizationActivity.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
164. Act.entryRelationship:immunizationActivity.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
166. Act.entryRelationship:immunizationActivity.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
168. Act.entryRelationship:immunizationActivity.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
170. Act.entryRelationship:immunizationActivity.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
172. Act.entryRelationship:immunizationActivity.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
174. Act.entryRelationship:immunizationActivity.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
176. Act.entryRelationship:immunizationActivity.substanceAdministration
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-30986).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Immunization Activity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. Act.entryRelationship:immunizationActivity.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
180. Act.entryRelationship:medicationActivity
Slice NamemedicationActivity
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
182. Act.entryRelationship:medicationActivity.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
184. Act.entryRelationship:medicationActivity.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
186. Act.entryRelationship:medicationActivity.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
188. Act.entryRelationship:medicationActivity.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
190. Act.entryRelationship:medicationActivity.typeCode
Comments

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

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
192. Act.entryRelationship:medicationActivity.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.
194. Act.entryRelationship:medicationActivity.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
196. Act.entryRelationship:medicationActivity.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.
198. Act.entryRelationship:medicationActivity.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
200. Act.entryRelationship:medicationActivity.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
202. Act.entryRelationship:medicationActivity.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
204. Act.entryRelationship:medicationActivity.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
206. Act.entryRelationship:medicationActivity.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
208. Act.entryRelationship:medicationActivity.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
210. Act.entryRelationship:medicationActivity.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
212. Act.entryRelationship:medicationActivity.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
214. Act.entryRelationship:medicationActivity.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
216. Act.entryRelationship:medicationActivity.substanceAdministration
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1198-30990).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Medication Activity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1098-30800: Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). ()
218. Act.entryRelationship:medicationActivity.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
220. Act.entryRelationship:interventionAct
Slice NameinterventionAct
ShortThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
222. Act.entryRelationship:interventionAct.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
224. Act.entryRelationship:interventionAct.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
226. Act.entryRelationship:interventionAct.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
228. Act.entryRelationship:interventionAct.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
230. Act.entryRelationship:interventionAct.typeCode
Comments

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

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
232. Act.entryRelationship:interventionAct.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.
234. Act.entryRelationship:interventionAct.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
236. Act.entryRelationship:interventionAct.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.
238. Act.entryRelationship:interventionAct.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
240. Act.entryRelationship:interventionAct.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
242. Act.entryRelationship:interventionAct.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] Intervention Act (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.131:2015-08-01) (CONF:1198-32460).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Intervention Act)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. Act.entryRelationship:interventionAct.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
246. Act.entryRelationship:interventionAct.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
248. Act.entryRelationship:interventionAct.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
250. Act.entryRelationship:interventionAct.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
252. Act.entryRelationship:interventionAct.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
254. Act.entryRelationship:interventionAct.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
256. Act.entryRelationship:interventionAct.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
258. Act.entryRelationship:interventionAct.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
260. Act.entryRelationship:procedureActivityProcedure
Slice NameprocedureActivityProcedure
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
262. Act.entryRelationship:procedureActivityProcedure.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
264. Act.entryRelationship:procedureActivityProcedure.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
266. Act.entryRelationship:procedureActivityProcedure.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
268. Act.entryRelationship:procedureActivityProcedure.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
270. Act.entryRelationship:procedureActivityProcedure.typeCode
Comments

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

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
272. Act.entryRelationship:procedureActivityProcedure.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.
274. Act.entryRelationship:procedureActivityProcedure.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
276. Act.entryRelationship:procedureActivityProcedure.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.
278. Act.entryRelationship:procedureActivityProcedure.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
280. Act.entryRelationship:procedureActivityProcedure.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
282. Act.entryRelationship:procedureActivityProcedure.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
284. Act.entryRelationship:procedureActivityProcedure.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
286. Act.entryRelationship:procedureActivityProcedure.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
288. Act.entryRelationship:procedureActivityProcedure.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
290. Act.entryRelationship:procedureActivityProcedure.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
292. Act.entryRelationship:procedureActivityProcedure.procedure
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Procedure Activity Procedure (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.14:2014-06-09) (CONF:1198-31170).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure(Procedure Activity Procedure)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. Act.entryRelationship:procedureActivityProcedure.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
296. Act.entryRelationship:procedureActivityProcedure.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
298. Act.entryRelationship:procedureActivityProcedure.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
300. Act.entryRelationship:encounterActivity
Slice NameencounterActivity
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
302. Act.entryRelationship:encounterActivity.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
304. Act.entryRelationship:encounterActivity.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
306. Act.entryRelationship:encounterActivity.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
308. Act.entryRelationship:encounterActivity.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
310. Act.entryRelationship:encounterActivity.typeCode
Comments

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

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
312. Act.entryRelationship:encounterActivity.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.
314. Act.entryRelationship:encounterActivity.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
316. Act.entryRelationship:encounterActivity.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.
318. Act.entryRelationship:encounterActivity.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
320. Act.entryRelationship:encounterActivity.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
322. Act.entryRelationship:encounterActivity.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
324. Act.entryRelationship:encounterActivity.encounter
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:1198-31173).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter(Encounter Activity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
326. Act.entryRelationship:encounterActivity.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
328. Act.entryRelationship:encounterActivity.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
330. Act.entryRelationship:encounterActivity.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
332. Act.entryRelationship:encounterActivity.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
334. Act.entryRelationship:encounterActivity.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
336. Act.entryRelationship:encounterActivity.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
338. Act.entryRelationship:encounterActivity.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
340. Act.entryRelationship:instruction
Slice Nameinstruction
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
342. 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
344. 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
346. 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
348. 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
350. Act.entryRelationship:instruction.typeCode
Comments

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

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
352. 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.
354. 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
356. 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.
358. Act.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
360. Act.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
362. 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:1198-31176).

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()))
364. Act.entryRelationship:instruction.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
366. Act.entryRelationship:instruction.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
368. Act.entryRelationship:instruction.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
370. Act.entryRelationship:instruction.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
372. Act.entryRelationship:instruction.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
374. Act.entryRelationship:instruction.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
376. Act.entryRelationship:instruction.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
378. Act.entryRelationship:instruction.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
380. Act.entryRelationship:nonMedSupply
Slice NamenonMedSupply
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
382. Act.entryRelationship:nonMedSupply.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
384. Act.entryRelationship:nonMedSupply.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
386. Act.entryRelationship:nonMedSupply.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
388. Act.entryRelationship:nonMedSupply.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
390. Act.entryRelationship:nonMedSupply.typeCode
Comments

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

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
392. Act.entryRelationship:nonMedSupply.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.
394. Act.entryRelationship:nonMedSupply.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
396. Act.entryRelationship:nonMedSupply.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.
398. Act.entryRelationship:nonMedSupply.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
400. Act.entryRelationship:nonMedSupply.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
402. Act.entryRelationship:nonMedSupply.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
404. Act.entryRelationship:nonMedSupply.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
406. Act.entryRelationship:nonMedSupply.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
408. Act.entryRelationship:nonMedSupply.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
410. Act.entryRelationship:nonMedSupply.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
412. Act.entryRelationship:nonMedSupply.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
414. Act.entryRelationship:nonMedSupply.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
416. Act.entryRelationship:nonMedSupply.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
418. Act.entryRelationship:nonMedSupply.supply
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Non-Medicinal Supply Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.50:2014-06-09) (CONF:1198-31179).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Non-Medicinal Supply Activity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
420. Act.entryRelationship:nutritionRecommendation
Slice NamenutritionRecommendation
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
422. Act.entryRelationship:nutritionRecommendation.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
424. Act.entryRelationship:nutritionRecommendation.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
426. Act.entryRelationship:nutritionRecommendation.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
428. Act.entryRelationship:nutritionRecommendation.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
430. Act.entryRelationship:nutritionRecommendation.typeCode
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.
432. Act.entryRelationship:nutritionRecommendation.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.
434. Act.entryRelationship:nutritionRecommendation.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
436. Act.entryRelationship:nutritionRecommendation.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.
438. Act.entryRelationship:nutritionRecommendation.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
440. Act.entryRelationship:nutritionRecommendation.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
442. Act.entryRelationship:nutritionRecommendation.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] Nutrition Recommendation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.130) (CONF:1198-31414).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Nutrition Recommendation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
444. Act.entryRelationship:nutritionRecommendation.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
446. Act.entryRelationship:nutritionRecommendation.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
448. Act.entryRelationship:nutritionRecommendation.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
450. Act.entryRelationship:nutritionRecommendation.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
452. Act.entryRelationship:nutritionRecommendation.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
454. Act.entryRelationship:nutritionRecommendation.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
456. Act.entryRelationship:nutritionRecommendation.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
458. Act.entryRelationship:nutritionRecommendation.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
460. Act.entryRelationship:entryReferenceRefr
Slice NameentryReferenceRefr
ShortWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
462. Act.entryRelationship:entryReferenceRefr.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
464. Act.entryRelationship:entryReferenceRefr.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
466. Act.entryRelationship:entryReferenceRefr.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
468. Act.entryRelationship:entryReferenceRefr.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
470. Act.entryRelationship:entryReferenceRefr.typeCode
Comments

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

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
472. Act.entryRelationship:entryReferenceRefr.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.
474. Act.entryRelationship:entryReferenceRefr.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
476. Act.entryRelationship:entryReferenceRefr.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.
478. Act.entryRelationship:entryReferenceRefr.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
480. Act.entryRelationship:entryReferenceRefr.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
482. Act.entryRelationship:entryReferenceRefr.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-31555).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
484. Act.entryRelationship:entryReferenceRefr.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
486. Act.entryRelationship:entryReferenceRefr.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
488. Act.entryRelationship:entryReferenceRefr.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
490. Act.entryRelationship:entryReferenceRefr.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
492. Act.entryRelationship:entryReferenceRefr.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
494. Act.entryRelationship:entryReferenceRefr.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
496. Act.entryRelationship:entryReferenceRefr.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
498. Act.entryRelationship:entryReferenceRefr.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
500. Act.entryRelationship:entryReferenceRson
Slice NameentryReferenceRson
ShortAn Intervention Act should reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
Comments

SHOULD contain zero or more [0..*] entryRelationship (CONF:1198-31621) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Invariants1198-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459). ()
502. Act.entryRelationship:entryReferenceRson.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
504. Act.entryRelationship:entryReferenceRson.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
506. Act.entryRelationship:entryReferenceRson.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
508. Act.entryRelationship:entryReferenceRson.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
510. Act.entryRelationship:entryReferenceRson.typeCode
Comments

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

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
512. Act.entryRelationship:entryReferenceRson.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.
514. Act.entryRelationship:entryReferenceRson.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
516. Act.entryRelationship:entryReferenceRson.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.
518. Act.entryRelationship:entryReferenceRson.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
520. Act.entryRelationship:entryReferenceRson.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
522. Act.entryRelationship:entryReferenceRson.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-31623).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
524. Act.entryRelationship:entryReferenceRson.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
526. Act.entryRelationship:entryReferenceRson.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
528. Act.entryRelationship:entryReferenceRson.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
530. Act.entryRelationship:entryReferenceRson.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
532. Act.entryRelationship:entryReferenceRson.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
534. Act.entryRelationship:entryReferenceRson.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
536. Act.entryRelationship:entryReferenceRson.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
538. Act.entryRelationship:entryReferenceRson.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
540. Act.entryRelationship:handoffCommunicationParticipants
Slice NamehandoffCommunicationParticipants
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
542. Act.entryRelationship:handoffCommunicationParticipants.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
544. Act.entryRelationship:handoffCommunicationParticipants.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
546. Act.entryRelationship:handoffCommunicationParticipants.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
548. Act.entryRelationship:handoffCommunicationParticipants.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
550. Act.entryRelationship:handoffCommunicationParticipants.typeCode
Comments

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

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
552. Act.entryRelationship:handoffCommunicationParticipants.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.
554. Act.entryRelationship:handoffCommunicationParticipants.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
556. Act.entryRelationship:handoffCommunicationParticipants.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.
558. Act.entryRelationship:handoffCommunicationParticipants.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
560. Act.entryRelationship:handoffCommunicationParticipants.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
562. Act.entryRelationship:handoffCommunicationParticipants.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] Handoff Communication Participants (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.141) (CONF:1198-32319).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Handoff Communication Participants)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
564. Act.entryRelationship:handoffCommunicationParticipants.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
566. Act.entryRelationship:handoffCommunicationParticipants.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
568. Act.entryRelationship:handoffCommunicationParticipants.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
570. Act.entryRelationship:handoffCommunicationParticipants.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
572. Act.entryRelationship:handoffCommunicationParticipants.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
574. Act.entryRelationship:handoffCommunicationParticipants.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
576. Act.entryRelationship:handoffCommunicationParticipants.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
578. Act.entryRelationship:handoffCommunicationParticipants.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
580. Act.entryRelationship:plannedInterventionAct
Slice NameplannedInterventionAct
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
582. Act.entryRelationship:plannedInterventionAct.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
584. Act.entryRelationship:plannedInterventionAct.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
586. Act.entryRelationship:plannedInterventionAct.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
588. Act.entryRelationship:plannedInterventionAct.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
590. Act.entryRelationship:plannedInterventionAct.typeCode
Comments

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

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
592. Act.entryRelationship:plannedInterventionAct.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.
594. Act.entryRelationship:plannedInterventionAct.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
596. Act.entryRelationship:plannedInterventionAct.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.
598. Act.entryRelationship:plannedInterventionAct.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
600. Act.entryRelationship:plannedInterventionAct.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
602. Act.entryRelationship:plannedInterventionAct.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] Planned Intervention Act (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.146:2015-08-01) (CONF:1198-32915).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Planned Intervention Act)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
604. Act.entryRelationship:plannedInterventionAct.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
606. Act.entryRelationship:plannedInterventionAct.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
608. Act.entryRelationship:plannedInterventionAct.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
610. Act.entryRelationship:plannedInterventionAct.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
612. Act.entryRelationship:plannedInterventionAct.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
614. Act.entryRelationship:plannedInterventionAct.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
616. Act.entryRelationship:plannedInterventionAct.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
618. Act.entryRelationship:plannedInterventionAct.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
620. Act.reference
Comments

MAY contain zero or more [0..*] reference (CONF:1198-32760).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
622. Act.reference.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
624. Act.reference.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
626. Act.reference.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
628. Act.reference.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
630. Act.reference.typeCode
Definition

Element Act.typeCode

Comments

The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32761).

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipExternalReference
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
632. Act.reference.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
634. Act.reference.externalAct
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalAct
636. Act.reference.externalObservation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation
638. Act.reference.externalProcedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure
640. Act.reference.externalDocument
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1198-32762).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument(External Document Reference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
642. Act.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition