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

Draft as of 2023-12-21

Definitions for the PatientReferralAct 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-priorityCode: SHOULD contain priorityCode (priorityCode.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
4. Act.templateId:patient-referral-act
Slice Namepatient-referral-act
Control1..1
6. Act.templateId:patient-referral-act.root
Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.140
8. Act.templateId:patient-referral-act.extension
Control0..0
10. Act.classCode
Comments

SHALL contain exactly one [1..1] @classCode="PCPR" provision of care (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-30884).

Fixed ValuePCPR
12. Act.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Patient Referral Act moodCode urn:oid:2.16.840.1.113883.11.20.9.66 STATIC 2014-09-01 (CONF:1098-30885).

BindingThe codes SHALL be taken from Patient Referral Act moodCode
14. Act.id
ShortIn the case of a Consultation Note where this referral is being fulfilled by this consultation, this id would be referenced in the inFullfilmentOf/order/id of the Consultation Note.
Comments

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

Control1..?
16. Act.code
Comments

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Referral Types urn:oid:2.16.840.1.113883.11.20.9.56 DYNAMIC (CONF:1098-30889).

BindingThe codes SHALL be taken from Referral Types
18. Act.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
20. 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('#'))
22. Act.statusCode
Comments

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

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

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

Control1..?
Fixed Valueactive
26. Act.effectiveTime
ShortThe effectiveTime represents the time when the future referral is intended to take place.
Comments

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

Control1..?
28. Act.priorityCode
Comments

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

30. 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:1098-31612).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
32. Act.participant
Comments

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

34. Act.participant.typeCode
Comments

The participant, if present, SHALL contain exactly one [1..1] @typeCode="REFT" Referred to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32638).

Fixed ValueREFT
36. Act.participant.participantRole
Comments

The participant, if present, SHALL contain exactly one [1..1] participantRole (CONF:1098-32636).

38. Act.participant.participantRole.code
Comments

This participantRole MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-32637).

BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
40. Act.entryRelationship
ShortThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
SlicingThis element introduces a set of slices on Act.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ observation
42. Act.entryRelationship:entryRelationship1
Slice NameentryRelationship1
ShortThe following entryRelationship represents whether the referral is for full or shared care.
Comments

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

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

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

Fixed ValueSUBJ
46. Act.entryRelationship:entryRelationship1.observation
Comments

SHALL contain exactly one [1..1] observation (CONF:1098-31605).

Control1..?
Invariantsshould-priorityCode: SHOULD contain priorityCode (priorityCode.exists())
48. Act.entryRelationship:entryRelationship1.observation.classCode
Comments

This observation SHALL contain exactly one [1..1] @classCode="OBS" observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31606).

Fixed ValueOBS
50. Act.entryRelationship:entryRelationship1.observation.moodCode
Comments

This observation SHALL contain exactly one [1..1] @moodCode="RQO" request (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31607).

Fixed ValueRQO
52. Act.entryRelationship:entryRelationship1.observation.code
Comments

This observation SHALL contain exactly one [1..1] code (CONF:1098-31608).

54. Act.entryRelationship:entryRelationship1.observation.code.code
Comments

This code SHALL contain exactly one [1..1] @code="ASSERTION" assertion (CONF:1098-31619).

Control1..?
Pattern ValueASSERTION
56. Act.entryRelationship:entryRelationship1.observation.code.codeSystem
Comments

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.4 " (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-31620).

Control1..?
Pattern Value2.16.840.1.113883.5.4
58. Act.entryRelationship:entryRelationship1.observation.statusCode
Comments

This observation SHALL contain exactly one [1..1] statusCode (CONF:1098-31614).

Control1..?
60. Act.entryRelationship:entryRelationship1.observation.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) (CONF:1098-31615).

Control1..?
Fixed Valuecompleted
62. Act.entryRelationship:entryRelationship1.observation.priorityCode
Comments

This observation SHOULD contain zero or one [0..1] priorityCode, which SHOULD be selected from ValueSet ActPriority urn:oid:2.16.840.1.113883.1.11.16866 DYNAMIC (CONF:1098-32443).

BindingThe codes SHOULD be taken from ActPriority
64. Act.entryRelationship:entryRelationship1.observation.value
Comments

This observation SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHOULD be selected from ValueSet Care Model urn:oid:2.16.840.1.113883.11.20.9.61 DYNAMIC (CONF:1098-31611).

Control1..1
BindingThe codes SHOULD be taken from Care Model
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
66. Act.entryRelationship:indication
Slice Nameindication
Comments

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

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

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

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

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

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)

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-priorityCode: SHOULD contain priorityCode (priorityCode.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
4. Act.templateId:patient-referral-act
Slice Namepatient-referral-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:patient-referral-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.140
8. Act.templateId:patient-referral-act.extension
Definition

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

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.
LabelExtension
10. Act.classCode
Comments

SHALL contain exactly one [1..1] @classCode="PCPR" provision of care (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-30884).

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 ValuePCPR
12. Act.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Patient Referral Act moodCode urn:oid:2.16.840.1.113883.11.20.9.66 STATIC 2014-09-01 (CONF:1098-30885).

Control1..1
BindingThe codes SHALL be taken from Patient Referral Act moodCode
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.
14. Act.id
ShortIn the case of a Consultation Note where this referral is being fulfilled by this consultation, this id would be referenced in the inFullfilmentOf/order/id of the Consultation Note.
Comments

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

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

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Referral Types urn:oid:2.16.840.1.113883.11.20.9.56 DYNAMIC (CONF:1098-30889).

Control1..1
BindingThe codes SHALL be taken from Referral Types
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
18. Act.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
20. 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('#'))
22. Act.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
24. Act.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Comments

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

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

Specifies the code system that defines the code.

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

The common name of the coding system.

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

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

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

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

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

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

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

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

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

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
40. Act.effectiveTime
ShortThe effectiveTime represents the time when the future referral is intended to take place.
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
42. Act.priorityCode
Comments

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

Control0..1
BindingFor example codes, see ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
44. 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:1098-31612).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
46. Act.participant
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
48. Act.participant.typeCode
Comments

The participant, if present, SHALL contain exactly one [1..1] @typeCode="REFT" Referred to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32638).

Control1..1
BindingThe codes SHALL be taken from ParticipationType
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 ValueREFT
50. Act.participant.participantRole
Comments

The participant, if present, SHALL contain exactly one [1..1] participantRole (CONF:1098-32636).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
52. Act.participant.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
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.
Default ValueROL
54. Act.participant.participantRole.code
Comments

This participantRole MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-32637).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
56. Act.entryRelationship
ShortThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
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:
  • profile @ observation
58. Act.entryRelationship:entryRelationship1
Slice NameentryRelationship1
ShortThe following entryRelationship represents whether the referral is for full or shared care.
Comments

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

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

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

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

SHALL contain exactly one [1..1] observation (CONF:1098-31605).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
Invariantsshould-priorityCode: SHOULD contain priorityCode (priorityCode.exists())
64. Act.entryRelationship:entryRelationship1.observation.classCode
Comments

This observation SHALL contain exactly one [1..1] @classCode="OBS" observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31606).

Control1..1
BindingThe codes SHALL be taken from ActClassObservation (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 ValueOBS
66. Act.entryRelationship:entryRelationship1.observation.moodCode
Comments

This observation SHALL contain exactly one [1..1] @moodCode="RQO" request (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31607).

Control1..1
BindingThe codes SHALL be taken from XActMoodDocumentObservation (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 ValueRQO
68. Act.entryRelationship:entryRelationship1.observation.code
Definition

Describes what was observed. Sometimes this is called the observation "name".

ShortType of observation (code / type)
Comments

This observation SHALL contain exactly one [1..1] code (CONF:1098-31608).


All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Control1..1
This element is affected by the following invariants: obs-7
BindingFor example codes, see ObservationTypehttp://hl7.org/fhir/ValueSet/observation-codes
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept
Is Modifierfalse
XML FormatThe type of this property is determined using the xsi:typeattribute.
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Alternate NamesName
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Act.entryRelationship:entryRelationship1.observation.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="ASSERTION" assertion (CONF:1098-31619).

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 ValueASSERTION
72. Act.entryRelationship:entryRelationship1.observation.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.5.4 " (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-31620).

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.5.4
74. Act.entryRelationship:entryRelationship1.observation.statusCode
Comments

This observation SHALL contain exactly one [1..1] statusCode (CONF:1098-31614).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
76. Act.entryRelationship:entryRelationship1.observation.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) (CONF:1098-31615).

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
78. Act.entryRelationship:entryRelationship1.observation.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
80. Act.entryRelationship:entryRelationship1.observation.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
82. Act.entryRelationship:entryRelationship1.observation.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
84. Act.entryRelationship:entryRelationship1.observation.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
86. Act.entryRelationship:entryRelationship1.observation.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
88. Act.entryRelationship:entryRelationship1.observation.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
90. Act.entryRelationship:entryRelationship1.observation.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
92. Act.entryRelationship:entryRelationship1.observation.priorityCode
Comments

This observation SHOULD contain zero or one [0..1] priorityCode, which SHOULD be selected from ValueSet ActPriority urn:oid:2.16.840.1.113883.1.11.16866 DYNAMIC (CONF:1098-32443).

Control0..1
BindingThe codes SHOULD be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
94. Act.entryRelationship:entryRelationship1.observation.value
Comments

This observation SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHOULD be selected from ValueSet Care Model urn:oid:2.16.840.1.113883.11.20.9.61 DYNAMIC (CONF:1098-31611).

Control1..1
BindingThe codes SHOULD be taken from Care Model
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
96. Act.entryRelationship:indication
Slice Nameindication
Comments

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

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

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

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
100. Act.entryRelationship:indication.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] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32634).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.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-priorityCode: SHOULD contain priorityCode (priorityCode.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
20. Act.templateId:patient-referral-act
Slice Namepatient-referral-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:patient-referral-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:patient-referral-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:patient-referral-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:patient-referral-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.140
30. Act.templateId:patient-referral-act.extension
Definition

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

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.
LabelExtension
32. Act.classCode
Comments

SHALL contain exactly one [1..1] @classCode="PCPR" provision of care (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-30884).

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 ValuePCPR
34. Act.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Patient Referral Act moodCode urn:oid:2.16.840.1.113883.11.20.9.66 STATIC 2014-09-01 (CONF:1098-30885).

Control1..1
BindingThe codes SHALL be taken from Patient Referral Act moodCode
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.
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
ShortIn the case of a Consultation Note where this referral is being fulfilled by this consultation, this id would be referenced in the inFullfilmentOf/order/id of the Consultation Note.
Comments

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

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

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Referral Types urn:oid:2.16.840.1.113883.11.20.9.56 DYNAMIC (CONF:1098-30889).

Control1..1
BindingThe codes SHALL be taken from Referral Types
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
42. Act.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
44. 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
46. 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
48. 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
50. 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
52. 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
54. 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
56. 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.
58. 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.
60. 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('#'))
62. 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
64. Act.statusCode
Comments

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

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

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Comments

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Fixed Valueactive
70. 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
72. 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
74. 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
76. 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
78. 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.
80. 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.
82. 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
84. 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
86. 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
88. Act.effectiveTime
ShortThe effectiveTime represents the time when the future referral is intended to take place.
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
90. Act.priorityCode
Comments

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

Control0..1
BindingFor example codes, see ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
92. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
94. Act.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
96. Act.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
98. Act.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
100. 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:1098-31612).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
102. Act.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
104. Act.participant
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
106. Act.participant.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
108. Act.participant.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
110. Act.participant.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
112. Act.participant.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
114. Act.participant.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
116. Act.participant.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
118. Act.participant.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
120. Act.participant.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
122. Act.participant.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
124. Act.participant.typeCode
Comments

The participant, if present, SHALL contain exactly one [1..1] @typeCode="REFT" Referred to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32638).

Control1..1
BindingThe codes SHALL be taken from ParticipationType
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 ValueREFT
126. Act.participant.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
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 ValueOP
128. Act.participant.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
130. Act.participant.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
132. Act.participant.awarenessCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
134. Act.participant.participantRole
Comments

The participant, if present, SHALL contain exactly one [1..1] participantRole (CONF:1098-32636).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
136. Act.participant.participantRole.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
138. Act.participant.participantRole.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
140. Act.participant.participantRole.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
142. Act.participant.participantRole.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
144. Act.participant.participantRole.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
146. Act.participant.participantRole.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
148. Act.participant.participantRole.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
150. Act.participant.participantRole.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
152. Act.participant.participantRole.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
154. Act.participant.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
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.
Default ValueROL
156. Act.participant.participantRole.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
158. Act.participant.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
160. Act.participant.participantRole.code
Comments

This participantRole MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-32637).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
162. Act.participant.participantRole.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
164. Act.participant.participantRole.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
166. Act.participant.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Device
168. Act.participant.participantRole.playingEntity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
170. Act.participant.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Entity
172. Act.entryRelationship
ShortThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
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:
  • profile @ observation
174. Act.entryRelationship:entryRelationship1
Slice NameentryRelationship1
ShortThe following entryRelationship represents whether the referral is for full or shared care.
Comments

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

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

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSUBJ
196. Act.entryRelationship:entryRelationship1.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.
198. Act.entryRelationship:entryRelationship1.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
200. Act.entryRelationship:entryRelationship1.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.
202. Act.entryRelationship:entryRelationship1.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
204. Act.entryRelationship:entryRelationship1.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
206. Act.entryRelationship:entryRelationship1.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
208. Act.entryRelationship:entryRelationship1.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
210. Act.entryRelationship:entryRelationship1.observation
Comments

SHALL contain exactly one [1..1] observation (CONF:1098-31605).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
Invariantsshould-priorityCode: SHOULD contain priorityCode (priorityCode.exists())
212. Act.entryRelationship:entryRelationship1.observation.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
214. Act.entryRelationship:entryRelationship1.observation.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
216. Act.entryRelationship:entryRelationship1.observation.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
218. Act.entryRelationship:entryRelationship1.observation.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
220. Act.entryRelationship:entryRelationship1.observation.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
222. Act.entryRelationship:entryRelationship1.observation.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
224. Act.entryRelationship:entryRelationship1.observation.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
226. Act.entryRelationship:entryRelationship1.observation.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
228. Act.entryRelationship:entryRelationship1.observation.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
230. Act.entryRelationship:entryRelationship1.observation.classCode
Comments

This observation SHALL contain exactly one [1..1] @classCode="OBS" observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31606).

Control1..1
BindingThe codes SHALL be taken from ActClassObservation (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 ValueOBS
232. Act.entryRelationship:entryRelationship1.observation.moodCode
Comments

This observation SHALL contain exactly one [1..1] @moodCode="RQO" request (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31607).

Control1..1
BindingThe codes SHALL be taken from XActMoodDocumentObservation (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 ValueRQO
234. Act.entryRelationship:entryRelationship1.observation.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.
236. Act.entryRelationship:entryRelationship1.observation.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
238. Act.entryRelationship:entryRelationship1.observation.code
Comments

This observation SHALL contain exactly one [1..1] code (CONF:1098-31608).

Control1..1
BindingFor example codes, see ObservationType
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
240. Act.entryRelationship:entryRelationship1.observation.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
242. Act.entryRelationship:entryRelationship1.observation.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="ASSERTION" assertion (CONF:1098-31619).

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 ValueASSERTION
244. Act.entryRelationship:entryRelationship1.observation.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.5.4 " (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-31620).

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.5.4
246. Act.entryRelationship:entryRelationship1.observation.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
248. Act.entryRelationship:entryRelationship1.observation.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
250. Act.entryRelationship:entryRelationship1.observation.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
252. Act.entryRelationship:entryRelationship1.observation.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.
254. Act.entryRelationship:entryRelationship1.observation.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.
256. Act.entryRelationship:entryRelationship1.observation.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
258. Act.entryRelationship:entryRelationship1.observation.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
260. Act.entryRelationship:entryRelationship1.observation.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
262. Act.entryRelationship:entryRelationship1.observation.derivationExpr
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
264. Act.entryRelationship:entryRelationship1.observation.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatThe type of this property is determined using the xsi:typeattribute.
266. Act.entryRelationship:entryRelationship1.observation.statusCode
Comments

This observation SHALL contain exactly one [1..1] statusCode (CONF:1098-31614).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
268. Act.entryRelationship:entryRelationship1.observation.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
270. Act.entryRelationship:entryRelationship1.observation.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) (CONF:1098-31615).

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
272. Act.entryRelationship:entryRelationship1.observation.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
274. Act.entryRelationship:entryRelationship1.observation.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
276. Act.entryRelationship:entryRelationship1.observation.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
278. Act.entryRelationship:entryRelationship1.observation.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
280. Act.entryRelationship:entryRelationship1.observation.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.
282. Act.entryRelationship:entryRelationship1.observation.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.
284. Act.entryRelationship:entryRelationship1.observation.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
286. Act.entryRelationship:entryRelationship1.observation.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
288. Act.entryRelationship:entryRelationship1.observation.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
290. Act.entryRelationship:entryRelationship1.observation.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
292. Act.entryRelationship:entryRelationship1.observation.priorityCode
Comments

This observation SHOULD contain zero or one [0..1] priorityCode, which SHOULD be selected from ValueSet ActPriority urn:oid:2.16.840.1.113883.1.11.16866 DYNAMIC (CONF:1098-32443).

Control0..1
BindingThe codes SHOULD be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
294. Act.entryRelationship:entryRelationship1.observation.repeatNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
296. Act.entryRelationship:entryRelationship1.observation.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
298. Act.entryRelationship:entryRelationship1.observation.value
Comments

This observation SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHOULD be selected from ValueSet Care Model urn:oid:2.16.840.1.113883.11.20.9.61 DYNAMIC (CONF:1098-31611).

Control1..1
BindingThe codes SHOULD be taken from Care Model
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
300. Act.entryRelationship:entryRelationship1.observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
302. Act.entryRelationship:entryRelationship1.observation.methodCode
Control0..*
BindingFor example codes, see ObservationMethod
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
304. Act.entryRelationship:entryRelationship1.observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
306. Act.entryRelationship:entryRelationship1.observation.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
308. Act.entryRelationship:entryRelationship1.observation.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
310. Act.entryRelationship:entryRelationship1.observation.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
312. Act.entryRelationship:entryRelationship1.observation.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
314. Act.entryRelationship:entryRelationship1.observation.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
316. Act.entryRelationship:entryRelationship1.observation.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
318. Act.entryRelationship:entryRelationship1.observation.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
320. Act.entryRelationship:entryRelationship1.observation.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
322. Act.entryRelationship:entryRelationship1.observation.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
324. Act.entryRelationship:entryRelationship1.observation.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.
326. Act.entryRelationship:entryRelationship1.observation.referenceRange
Definition

Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
328. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
330. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
332. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
334. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
336. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
338. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
340. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
342. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
344. Act.entryRelationship:entryRelationship1.observation.referenceRange.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
346. Act.entryRelationship:entryRelationship1.observation.referenceRange.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipType (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 ValueREFV
348. Act.entryRelationship:entryRelationship1.observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationRange
350. Act.entryRelationship:entryRelationship1.observation.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.
352. Act.entryRelationship:entryRelationship1.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
354. Act.entryRelationship:entryRelationship1.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
356. Act.entryRelationship:entryRelationship1.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
358. Act.entryRelationship:entryRelationship1.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
360. Act.entryRelationship:entryRelationship1.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
362. Act.entryRelationship:entryRelationship1.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
364. Act.entryRelationship:indication
Slice Nameindication
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
366. Act.entryRelationship:indication.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from 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
368. Act.entryRelationship:indication.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
370. Act.entryRelationship:indication.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
372. Act.entryRelationship:indication.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
374. Act.entryRelationship:indication.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
376. Act.entryRelationship:indication.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
378. Act.entryRelationship:indication.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
380. Act.entryRelationship:indication.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
382. Act.entryRelationship:indication.templateId
Definition

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

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

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

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
386. Act.entryRelationship:indication.inversionInd
Definition

The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
388. Act.entryRelationship:indication.contextConductionInd
Definition

The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
390. Act.entryRelationship:indication.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
392. Act.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
394. Act.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
396. Act.entryRelationship:indication.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
398. Act.entryRelationship:indication.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
400. Act.entryRelationship:indication.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] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32634).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
402. Act.entryRelationship:indication.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
404. Act.entryRelationship:indication.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
406. Act.entryRelationship:indication.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
408. Act.entryRelationship:indication.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
410. Act.entryRelationship:indication.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
412. Act.entryRelationship:indication.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
414. Act.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
416. Act.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
418. 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.
420. 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.