Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: InterventionAct - Detailed Descriptions

Draft as of 2023-12-21

Definitions for the InterventionAct logical model.

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

0. Act
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
2. 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:
  • value @ root
  • value @ extension
4. Act.templateId:intervention-act
Slice Nameintervention-act
Control1..1
6. Act.templateId:intervention-act.root
Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.131
8. Act.templateId:intervention-act.extension
Control1..?
Pattern Value2015-08-01
10. 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
12. 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
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.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
24. Act.text.reference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
26. Act.statusCode
Comments

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

Control1..?
28. 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
30. Act.effectiveTime
Comments

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

32. 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)
34. 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:
  • value @ typeCode
  • profile @ observation
  • profile @ substanceAdministration
  • profile @ act
  • profile @ procedure
  • profile @ encounter
  • profile @ supply
36. Act.entryRelationship:advanceDirectiveObservation
Slice NameadvanceDirectiveObservation
Comments

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

Control0..*
38. 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
40. 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)
42. Act.entryRelationship:immunizationActivity
Slice NameimmunizationActivity
Comments

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

Control0..*
44. 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
46. 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)
48. Act.entryRelationship:medicationActivity
Slice NamemedicationActivity
Comments

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

Control0..*
50. 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
52. 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)
54. 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..*
56. 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
58. 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)
60. Act.entryRelationship:procedureActivityProcedure
Slice NameprocedureActivityProcedure
Comments

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

Control0..*
62. 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
64. 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)
66. Act.entryRelationship:encounterActivity
Slice NameencounterActivity
Comments

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

Control0..*
68. 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
70. 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)
72. Act.entryRelationship:instruction
Slice Nameinstruction
Comments

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

Control0..*
74. 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
76. 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)
78. Act.entryRelationship:nonMedSupply
Slice NamenonMedSupply
Comments

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

Control0..*
80. 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
82. 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)
84. Act.entryRelationship:nutritionRecommendation
Slice NamenutritionRecommendation
Comments

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

Control0..*
86. Act.entryRelationship:nutritionRecommendation.typeCode
Fixed ValueREFR
88. 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)
90. 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..*
92. 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
94. 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)
96. 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..*
Invariantsentry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. (%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)))
98. 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
100. 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)
102. Act.entryRelationship:handoffCommunicationParticipants
Slice NamehandoffCommunicationParticipants
Comments

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

Control0..*
104. 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
106. 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)
108. Act.entryRelationship:plannedInterventionAct
Slice NameplannedInterventionAct
Comments

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

Control0..*
110. 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
112. 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)
114. Act.reference
Comments

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

116. 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
118. 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

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
2. 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:
  • value @ root
  • value @ extension
4. Act.templateId:intervention-act
Slice Nameintervention-act
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
6. Act.templateId:intervention-act.root
Definition

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

Control1..1
Typestring(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
8. Act.templateId:intervention-act.extension
Definition

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

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
10. 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
BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
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
12. 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
BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
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
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
BindingFor example codes, see 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.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
24. Act.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
26. 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
28. 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
30. 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
32. 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
34. 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
36. 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
38. 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
40. 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
42. 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
44. 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
46. Act.author
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
48. 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:
  • value @ typeCode
  • profile @ observation
  • profile @ substanceAdministration
  • profile @ act
  • profile @ procedure
  • profile @ encounter
  • profile @ supply
50. 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
52. 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
54. Act.entryRelationship:advanceDirectiveObservation.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-author: SHOULD contain author (author.exists())
should-informant: SHOULD contain informant (informant.exists())
56. 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
58. 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
60. Act.entryRelationship:immunizationActivity.substanceAdministration
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-doseQuantity: SHOULD contain doseQuantity (doseQuantity.exists())
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
should-performer: SHOULD contain performer (performer.exists())
should-author: SHOULD contain author (author.exists())
62. 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
64. 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
66. Act.entryRelationship:medicationActivity.substanceAdministration
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). (effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists())
should-routeCode: SHOULD contain routeCode (routeCode.exists())
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
should-author: SHOULD contain author (author.exists())
68. 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
70. 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
72. Act.entryRelationship:interventionAct.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
74. 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
76. 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
78. Act.entryRelationship:procedureActivityProcedure.procedure
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
active-high-ts-after-document: If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime ((statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value)
should-targetSiteCode: SHOULD contain targetSiteCode (targetSiteCode.exists())
should-performer: SHOULD contain performer (performer.exists())
should-author: SHOULD contain author (author.exists())
80. 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
82. 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
84. Act.entryRelationship:encounterActivity.encounter
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
86. 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
88. 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
90. Act.entryRelationship:instruction.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
92. 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
94. 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
96. Act.entryRelationship:nonMedSupply.supply
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-quantity: SHOULD contain quantity (quantity.exists())
98. 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
100. 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.
Fixed ValueREFR
102. Act.entryRelationship:nutritionRecommendation.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
104. 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
106. 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
108. Act.entryRelationship:entryReferenceRefr.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
110. 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
Invariantsentry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. (%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)))
112. 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
114. Act.entryRelationship:entryReferenceRson.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
116. 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
118. 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
120. Act.entryRelationship:handoffCommunicationParticipants.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
122. 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
124. 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
126. Act.entryRelationship:plannedInterventionAct.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
128. Act.reference
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
130. 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).

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
132. Act.reference.externalDocument
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-setId: SHOULD contain setId (setId.exists())
should-versionNumber: SHOULD contain versionNumber (versionNumber.exists())

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

0. Act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
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 CDANullFlavor
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.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
6. Act.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
8. Act.typeId.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 CDANullFlavor
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
10. Act.typeId.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
12. Act.typeId.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
14. Act.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
16. Act.typeId.extension
Definition

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

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
18. 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:
  • value @ root
  • value @ extension
20. Act.templateId:intervention-act
Slice Nameintervention-act
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
22. Act.templateId:intervention-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 CDANullFlavor
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
24. Act.templateId:intervention-act.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
26. Act.templateId:intervention-act.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
28. Act.templateId:intervention-act.root
Definition

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

Control1..1
Typestring(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
30. Act.templateId:intervention-act.extension
Definition

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

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
32. 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
BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
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
34. 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
BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
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
36. 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.
38. Act.id
Comments

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

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

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

Control1..1
BindingFor example codes, see v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
42. 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 CDANullFlavor
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
44. 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
46. 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
48. 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
50. 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
52. 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
54. 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.
56. 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.
58. 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
60. 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
62. 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
64. Act.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
66. Act.text.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 CDANullFlavor
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
68. Act.text.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
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.
LabelCompression
70. Act.text.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..1
Typebase64Binary(bin: Binary Data)
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.
LabelIntegrity Check
72. Act.text.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
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.
LabelIntegrity Check Algorithm
74. Act.text.language
Definition

For character based information the language property specifies the human language of the text.

Control0..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.
LabelLanguage
76. Act.text.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
BindingFor example codes, see MediaType
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.
LabelMedia Type
78. Act.text.representation
Control0..1
BindingThe codes SHALL be taken from Binary Data Encoding Value Set
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.
80. Act.text.xmlText
Definition

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

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 unadorned text.
82. Act.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
84. Act.text.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelThumbnail
86. 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
88. 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 CDANullFlavor
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
90. 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
92. 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
94. 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
96. 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
98. 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
100. 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.
102. 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.
104. 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
106. 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
108. 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
110. 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
112. Act.priorityCode
Control0..1
BindingFor example codes, see ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
114. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
116. Act.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
118. Act.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
120. Act.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
122. Act.author
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
124. Act.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
126. Act.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
128. 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:
  • value @ typeCode
  • profile @ observation
  • profile @ substanceAdministration
  • profile @ act
  • profile @ procedure
  • profile @ encounter
  • profile @ supply
130. 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
132. 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 CDANullFlavor
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
134. 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
136. 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
138. Act.entryRelationship:advanceDirectiveObservation.typeId.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 CDANullFlavor
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
140. Act.entryRelationship:advanceDirectiveObservation.typeId.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
142. Act.entryRelationship:advanceDirectiveObservation.typeId.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
144. Act.entryRelationship:advanceDirectiveObservation.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
146. Act.entryRelationship:advanceDirectiveObservation.typeId.extension
Definition

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

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
148. 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
150. 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
152. 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.
154. 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
156. 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.
158. Act.entryRelationship:advanceDirectiveObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
160. Act.entryRelationship:advanceDirectiveObservation.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
162. Act.entryRelationship:advanceDirectiveObservation.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
164. Act.entryRelationship:advanceDirectiveObservation.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
166. Act.entryRelationship:advanceDirectiveObservation.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-author: SHOULD contain author (author.exists())
should-informant: SHOULD contain informant (informant.exists())
168. Act.entryRelationship:advanceDirectiveObservation.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
170. Act.entryRelationship:advanceDirectiveObservation.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
172. Act.entryRelationship:advanceDirectiveObservation.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
174. Act.entryRelationship:advanceDirectiveObservation.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
176. Act.entryRelationship:advanceDirectiveObservation.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
178. Act.entryRelationship:advanceDirectiveObservation.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
180. 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
182. 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 CDANullFlavor
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: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
186. 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
188. Act.entryRelationship:immunizationActivity.typeId.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 CDANullFlavor
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
190. Act.entryRelationship:immunizationActivity.typeId.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
192. Act.entryRelationship:immunizationActivity.typeId.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
194. Act.entryRelationship:immunizationActivity.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
196. Act.entryRelationship:immunizationActivity.typeId.extension
Definition

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

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

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-doseQuantity: SHOULD contain doseQuantity (doseQuantity.exists())
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
should-performer: SHOULD contain performer (performer.exists())
should-author: SHOULD contain author (author.exists())
228. Act.entryRelationship:immunizationActivity.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
230. 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
232. 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 CDANullFlavor
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
234. 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
236. 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
238. Act.entryRelationship:medicationActivity.typeId.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 CDANullFlavor
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
240. Act.entryRelationship:medicationActivity.typeId.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
242. Act.entryRelationship:medicationActivity.typeId.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
244. Act.entryRelationship:medicationActivity.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
246. Act.entryRelationship:medicationActivity.typeId.extension
Definition

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

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
248. 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
250. 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
252. 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.
254. 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
256. 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.
258. Act.entryRelationship:medicationActivity.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
260. Act.entryRelationship:medicationActivity.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
262. Act.entryRelationship:medicationActivity.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
264. Act.entryRelationship:medicationActivity.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
266. Act.entryRelationship:medicationActivity.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
268. Act.entryRelationship:medicationActivity.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
270. Act.entryRelationship:medicationActivity.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
272. Act.entryRelationship:medicationActivity.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
274. Act.entryRelationship:medicationActivity.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
276. Act.entryRelationship:medicationActivity.substanceAdministration
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). (effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists())
should-routeCode: SHOULD contain routeCode (routeCode.exists())
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
should-author: SHOULD contain author (author.exists())
278. Act.entryRelationship:medicationActivity.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
280. 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
282. 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 CDANullFlavor
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
284. 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
286. 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
288. Act.entryRelationship:interventionAct.typeId.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 CDANullFlavor
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
290. Act.entryRelationship:interventionAct.typeId.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
292. Act.entryRelationship:interventionAct.typeId.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
294. Act.entryRelationship:interventionAct.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
296. Act.entryRelationship:interventionAct.typeId.extension
Definition

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

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
298. 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
300. 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
302. 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.
304. 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
306. 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.
308. Act.entryRelationship:interventionAct.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
310. Act.entryRelationship:interventionAct.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
312. Act.entryRelationship:interventionAct.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
314. Act.entryRelationship:interventionAct.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
316. Act.entryRelationship:interventionAct.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
318. Act.entryRelationship:interventionAct.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
320. Act.entryRelationship:interventionAct.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
322. Act.entryRelationship:interventionAct.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
324. Act.entryRelationship:interventionAct.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
326. Act.entryRelationship:interventionAct.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
328. Act.entryRelationship:interventionAct.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
330. 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
332. 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 CDANullFlavor
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
334. 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
336. 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
338. Act.entryRelationship:procedureActivityProcedure.typeId.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 CDANullFlavor
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
340. Act.entryRelationship:procedureActivityProcedure.typeId.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
342. Act.entryRelationship:procedureActivityProcedure.typeId.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
344. Act.entryRelationship:procedureActivityProcedure.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
346. Act.entryRelationship:procedureActivityProcedure.typeId.extension
Definition

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

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
348. 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
350. 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
352. 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.
354. 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
356. 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.
358. Act.entryRelationship:procedureActivityProcedure.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
360. Act.entryRelationship:procedureActivityProcedure.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
362. Act.entryRelationship:procedureActivityProcedure.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
364. Act.entryRelationship:procedureActivityProcedure.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
366. Act.entryRelationship:procedureActivityProcedure.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
368. Act.entryRelationship:procedureActivityProcedure.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
370. Act.entryRelationship:procedureActivityProcedure.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
372. Act.entryRelationship:procedureActivityProcedure.procedure
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
active-high-ts-after-document: If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime ((statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value)
should-targetSiteCode: SHOULD contain targetSiteCode (targetSiteCode.exists())
should-performer: SHOULD contain performer (performer.exists())
should-author: SHOULD contain author (author.exists())
374. Act.entryRelationship:procedureActivityProcedure.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
376. Act.entryRelationship:procedureActivityProcedure.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
378. Act.entryRelationship:procedureActivityProcedure.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
380. 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
382. 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 CDANullFlavor
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: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
386. 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
388. Act.entryRelationship:encounterActivity.typeId.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 CDANullFlavor
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
390. Act.entryRelationship:encounterActivity.typeId.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
392. Act.entryRelationship:encounterActivity.typeId.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
394. Act.entryRelationship:encounterActivity.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
396. Act.entryRelationship:encounterActivity.typeId.extension
Definition

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

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
398. 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
400. 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
402. 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.
404. 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
406. 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.
408. Act.entryRelationship:encounterActivity.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
410. Act.entryRelationship:encounterActivity.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
412. Act.entryRelationship:encounterActivity.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
414. Act.entryRelationship:encounterActivity.encounter
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
416. Act.entryRelationship:encounterActivity.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
418. Act.entryRelationship:encounterActivity.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
420. Act.entryRelationship:encounterActivity.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
422. Act.entryRelationship:encounterActivity.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
424. Act.entryRelationship:encounterActivity.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
426. Act.entryRelationship:encounterActivity.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
428. Act.entryRelationship:encounterActivity.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
430. 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
432. 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 CDANullFlavor
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
434. 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
436. 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
438. Act.entryRelationship:instruction.typeId.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 CDANullFlavor
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
440. Act.entryRelationship:instruction.typeId.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
442. Act.entryRelationship:instruction.typeId.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
444. Act.entryRelationship:instruction.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
446. Act.entryRelationship:instruction.typeId.extension
Definition

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

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
448. 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
450. 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
452. 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.
454. 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
456. 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.
458. Act.entryRelationship:instruction.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
460. Act.entryRelationship:instruction.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
462. Act.entryRelationship:instruction.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
464. Act.entryRelationship:instruction.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
466. Act.entryRelationship:instruction.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
468. Act.entryRelationship:instruction.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
470. Act.entryRelationship:instruction.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
472. Act.entryRelationship:instruction.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
474. Act.entryRelationship:instruction.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
476. Act.entryRelationship:instruction.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
478. Act.entryRelationship:instruction.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
480. 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
482. 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 CDANullFlavor
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
484. 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
486. 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
488. Act.entryRelationship:nonMedSupply.typeId.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 CDANullFlavor
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
490. Act.entryRelationship:nonMedSupply.typeId.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
492. Act.entryRelationship:nonMedSupply.typeId.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
494. Act.entryRelationship:nonMedSupply.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
496. Act.entryRelationship:nonMedSupply.typeId.extension
Definition

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

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
498. 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
500. 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
502. 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.
504. 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
506. 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.
508. Act.entryRelationship:nonMedSupply.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
510. Act.entryRelationship:nonMedSupply.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
512. Act.entryRelationship:nonMedSupply.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
514. Act.entryRelationship:nonMedSupply.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
516. Act.entryRelationship:nonMedSupply.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
518. Act.entryRelationship:nonMedSupply.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
520. Act.entryRelationship:nonMedSupply.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
522. Act.entryRelationship:nonMedSupply.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
524. Act.entryRelationship:nonMedSupply.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
526. Act.entryRelationship:nonMedSupply.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
528. Act.entryRelationship:nonMedSupply.supply
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-quantity: SHOULD contain quantity (quantity.exists())
530. 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
532. 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 CDANullFlavor
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
534. 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
536. 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
538. Act.entryRelationship:nutritionRecommendation.typeId.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 CDANullFlavor
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
540. Act.entryRelationship:nutritionRecommendation.typeId.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
542. Act.entryRelationship:nutritionRecommendation.typeId.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
544. Act.entryRelationship:nutritionRecommendation.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
546. Act.entryRelationship:nutritionRecommendation.typeId.extension
Definition

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

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
548. 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
550. 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.
Fixed ValueREFR
552. 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.
554. 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
556. 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.
558. Act.entryRelationship:nutritionRecommendation.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
560. Act.entryRelationship:nutritionRecommendation.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
562. Act.entryRelationship:nutritionRecommendation.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
564. Act.entryRelationship:nutritionRecommendation.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
566. Act.entryRelationship:nutritionRecommendation.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
568. Act.entryRelationship:nutritionRecommendation.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
570. Act.entryRelationship:nutritionRecommendation.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
572. Act.entryRelationship:nutritionRecommendation.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
574. Act.entryRelationship:nutritionRecommendation.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
576. Act.entryRelationship:nutritionRecommendation.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
578. Act.entryRelationship:nutritionRecommendation.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
580. 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
582. 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 CDANullFlavor
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: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
586. 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
588. Act.entryRelationship:entryReferenceRefr.typeId.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 CDANullFlavor
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
590. Act.entryRelationship:entryReferenceRefr.typeId.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
592. Act.entryRelationship:entryReferenceRefr.typeId.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
594. Act.entryRelationship:entryReferenceRefr.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
596. Act.entryRelationship:entryReferenceRefr.typeId.extension
Definition

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

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
598. 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
600. 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
602. 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.
604. 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
606. 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.
608. Act.entryRelationship:entryReferenceRefr.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
610. Act.entryRelationship:entryReferenceRefr.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
612. Act.entryRelationship:entryReferenceRefr.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
614. Act.entryRelationship:entryReferenceRefr.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
616. Act.entryRelationship:entryReferenceRefr.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
618. Act.entryRelationship:entryReferenceRefr.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
620. Act.entryRelationship:entryReferenceRefr.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
622. Act.entryRelationship:entryReferenceRefr.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
624. Act.entryRelationship:entryReferenceRefr.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
626. Act.entryRelationship:entryReferenceRefr.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
628. Act.entryRelationship:entryReferenceRefr.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
630. 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
Invariantsentry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. (%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)))
632. 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 CDANullFlavor
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
634. 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
636. 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
638. Act.entryRelationship:entryReferenceRson.typeId.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 CDANullFlavor
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
640. Act.entryRelationship:entryReferenceRson.typeId.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
642. Act.entryRelationship:entryReferenceRson.typeId.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
644. Act.entryRelationship:entryReferenceRson.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
646. Act.entryRelationship:entryReferenceRson.typeId.extension
Definition

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

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
648. 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
650. 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
652. 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.
654. 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
656. 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.
658. Act.entryRelationship:entryReferenceRson.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
660. Act.entryRelationship:entryReferenceRson.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
662. Act.entryRelationship:entryReferenceRson.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
664. Act.entryRelationship:entryReferenceRson.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
666. Act.entryRelationship:entryReferenceRson.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
668. Act.entryRelationship:entryReferenceRson.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
670. Act.entryRelationship:entryReferenceRson.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
672. Act.entryRelationship:entryReferenceRson.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
674. Act.entryRelationship:entryReferenceRson.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
676. Act.entryRelationship:entryReferenceRson.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
678. Act.entryRelationship:entryReferenceRson.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
680. 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
682. 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 CDANullFlavor
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
684. 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
686. 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
688. Act.entryRelationship:handoffCommunicationParticipants.typeId.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 CDANullFlavor
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
690. Act.entryRelationship:handoffCommunicationParticipants.typeId.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
692. Act.entryRelationship:handoffCommunicationParticipants.typeId.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
694. Act.entryRelationship:handoffCommunicationParticipants.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
696. Act.entryRelationship:handoffCommunicationParticipants.typeId.extension
Definition

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

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
698. 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
700. 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
702. 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.
704. 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
706. 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.
708. Act.entryRelationship:handoffCommunicationParticipants.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
710. Act.entryRelationship:handoffCommunicationParticipants.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
712. Act.entryRelationship:handoffCommunicationParticipants.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
714. Act.entryRelationship:handoffCommunicationParticipants.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
716. Act.entryRelationship:handoffCommunicationParticipants.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
718. Act.entryRelationship:handoffCommunicationParticipants.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
720. Act.entryRelationship:handoffCommunicationParticipants.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
722. Act.entryRelationship:handoffCommunicationParticipants.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
724. Act.entryRelationship:handoffCommunicationParticipants.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
726. Act.entryRelationship:handoffCommunicationParticipants.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
728. Act.entryRelationship:handoffCommunicationParticipants.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
730. 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
732. 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 CDANullFlavor
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
734. 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
736. 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
738. Act.entryRelationship:plannedInterventionAct.typeId.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 CDANullFlavor
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
740. Act.entryRelationship:plannedInterventionAct.typeId.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
742. Act.entryRelationship:plannedInterventionAct.typeId.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
744. Act.entryRelationship:plannedInterventionAct.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
746. Act.entryRelationship:plannedInterventionAct.typeId.extension
Definition

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

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
748. 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
750. 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
752. 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.
754. 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
756. 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.
758. Act.entryRelationship:plannedInterventionAct.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
760. Act.entryRelationship:plannedInterventionAct.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
762. Act.entryRelationship:plannedInterventionAct.act
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
764. Act.entryRelationship:plannedInterventionAct.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
766. Act.entryRelationship:plannedInterventionAct.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
768. Act.entryRelationship:plannedInterventionAct.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
770. Act.entryRelationship:plannedInterventionAct.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
772. Act.entryRelationship:plannedInterventionAct.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
774. Act.entryRelationship:plannedInterventionAct.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
776. Act.entryRelationship:plannedInterventionAct.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
778. Act.entryRelationship:plannedInterventionAct.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
780. Act.reference
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
782. 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 CDANullFlavor
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
784. 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
786. 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
788. Act.reference.typeId.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 CDANullFlavor
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
790. Act.reference.typeId.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
792. Act.reference.typeId.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
794. Act.reference.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
796. Act.reference.typeId.extension
Definition

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

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
798. 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
800. 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).

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
802. Act.reference.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
804. Act.reference.externalAct
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalAct
806. Act.reference.externalObservation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation
808. Act.reference.externalProcedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure
810. Act.reference.externalDocument
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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
Invariantsshould-setId: SHOULD contain setId (setId.exists())
should-versionNumber: SHOULD contain versionNumber (versionNumber.exists())
812. Act.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
814. Act.sdtcPrecondition2
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
816. Act.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.