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

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

Logical Model: ConsultationNote - Detailed Descriptions

Active as of 2023-09-29

Definitions for the ConsultationNote logical model.

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

0. ClinicalDocument
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ClinicalDocument.templateId
Control2..?
4. ClinicalDocument.templateId:secondary
Slice Namesecondary
Comments

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

Control1..1
6. ClinicalDocument.templateId:secondary.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.4" (CONF:1198-10040).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.1.4
8. ClinicalDocument.templateId:secondary.extension
Comments

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

Control1..?
Pattern Value2015-08-01
10. ClinicalDocument.code
ShortThe Consultation Note recommends use of the document type code 11488-4 "Consult Note", with further specification provided by author or performer, setting, or specialty. When pre-coordinated codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Comments

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet ConsultDocumentType http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.11.20.9.31 DYNAMIC (CONF:1198-17176).

BindingThe codes SHALL be taken from ConsultDocumentType
12. ClinicalDocument.participant
ShortThis participant represents the person to contact for questions about the consult summary. This call back contact individual may be a different person than the individual(s) identified in the author or legalAuthenticator participant.
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ ClinicalDocument.typeCode
14. ClinicalDocument.participant:participant1
Slice Nameparticipant1
Comments

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

Control0..*
16. ClinicalDocument.participant:participant1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="CALLBCK" call back contact (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 DYNAMIC) (CONF:1198-31657).

Control1..?
Fixed ValueCALLBCK
18. ClinicalDocument.participant:participant1.associatedEntity
Comments

SHALL contain exactly one [1..1] associatedEntity (CONF:1198-31658).

20. ClinicalDocument.participant:participant1.associatedEntity.classCode
Comments

This associatedEntity SHALL contain exactly one [1..1] @classCode="ASSIGNED" assigned entity (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 DYNAMIC) (CONF:1198-31659).

Fixed ValueASSIGNED
22. ClinicalDocument.participant:participant1.associatedEntity.id
Comments

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

Control1..?
24. ClinicalDocument.participant:participant1.associatedEntity.addr
Comments

This associatedEntity SHOULD contain zero or more [0..*] addr (CONF:1198-31661).

26. ClinicalDocument.participant:participant1.associatedEntity.telecom
Comments

This associatedEntity SHALL contain at least one [1..*] telecom (CONF:1198-31662).

Control1..?
28. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson
Comments

This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:1198-31663).

Control1..?
30. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.name
Comments

This associatedPerson SHALL contain at least one [1..*] name (CONF:1198-31664).

Control1..?
32. ClinicalDocument.participant:participant1.associatedEntity.scopingOrganization
Comments

This associatedEntity MAY contain zero or one [0..1] scopingOrganization (CONF:1198-31665).

34. ClinicalDocument.inFulfillmentOf
ShortThe inFulfillmentOf element describes prior orders that are fulfilled (in whole or part) by the service events described in the Consultation Note. For example, a prior order might be the consultation that is being reported in the note.
Comments

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

Control1..?
36. ClinicalDocument.inFulfillmentOf.order
Comments

Such inFulfillmentOfs SHALL contain exactly one [1..1] order (CONF:1198-29923).

38. ClinicalDocument.inFulfillmentOf.order.id
ShortWhere a referral is being fulfilled by this consultation, this id would be the same as the id in the Patient Referral Act template.
Comments

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

40. ClinicalDocument.componentOf
ShortA Consultation Note is always associated with an encounter; the id element of the encompassingEncounter is required to be present and represents the identifier for the encounter.
Comments

SHALL contain exactly one [1..1] componentOf (CONF:1198-8386).

Control1..?
42. ClinicalDocument.componentOf.encompassingEncounter
Comments

This componentOf SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-8387).

44. ClinicalDocument.componentOf.encompassingEncounter.id
Comments

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

46. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments

This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8389).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time (DT.US.FIELDED))
48. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Comments

This encompassingEncounter MAY contain zero or one [0..1] responsibleParty (CONF:1198-8391).

50. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Comments

The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).

Invariants1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). ()
52. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
ShortThe encounterParticipant element represents persons who participated in the encounter and not necessarily the entire episode of care.
Comments

This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8392).

54. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.assignedEntity
Comments

The encounterParticipant, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32902).

Control1..?
Invariants1198-32906: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32906). ()
56. ClinicalDocument.component
Comments

SHALL contain exactly one [1..1] component (CONF:1198-8397).

58. ClinicalDocument.component.structuredBody
Comments

This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-28895).

Control1..?
Invariants1198-28939: This structuredBody **SHALL NOT** contain an Assessment and Plan Section (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present (CONF:1198-28939). ()
1198-28940: This structuredBody **SHALL NOT** contain a Chief Complaint and Reason for Visit Section (2.16.840.1.113883.10.20.22.2.13) when either a Chief Complaint Section (1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) or a Reason for Visit Section (2.16.840.1.113883.10.20.22.2.12) is present (CONF:1198-28940). ()
1198-9504: **SHALL** include a Reason for Referral or Reason for Visit section (CONF:1198-9504). ()
1198-9501: **SHALL** include an Assessment and Plan Section, or both an Assessment Section and a Plan of Treatment Section (CONF:1198-9501). ()
60. ClinicalDocument.component.structuredBody.component
Control5..?
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ section
62. ClinicalDocument.component.structuredBody.component:component1
Slice Namecomponent1
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28896) such that it

Control0..1
64. ClinicalDocument.component.structuredBody.component:component1.section
Comments

The component, if present, SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-28897).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Assessment Section)
66. ClinicalDocument.component.structuredBody.component:component2
Slice Namecomponent2
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28898) such that it

Control0..1
68. ClinicalDocument.component.structuredBody.component:component2.section
Comments

SHALL contain exactly one [1..1] Assessment and Plan Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.9:2014-06-09) (CONF:1198-28899).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Assessment and Plan Section)
70. ClinicalDocument.component.structuredBody.component:component3
Slice Namecomponent3
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28900) such that it

Control0..1
72. ClinicalDocument.component.structuredBody.component:component3.section
Comments

SHALL contain exactly one [1..1] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-28901).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
74. ClinicalDocument.component.structuredBody.component:component4
Slice Namecomponent4
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28904) such that it

Control0..1
76. ClinicalDocument.component.structuredBody.component:component4.section
Comments

SHALL contain exactly one [1..1] Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.12) (CONF:1198-28905).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Reason for Visit Section)
78. ClinicalDocument.component.structuredBody.component:component5
Slice Namecomponent5
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28906) such that it

Control1..1
80. ClinicalDocument.component.structuredBody.component:component5.section
Comments

SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-28907).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(History of Present Illness Section)
82. ClinicalDocument.component.structuredBody.component:component6
Slice Namecomponent6
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28908) such that it

Control0..1
84. ClinicalDocument.component.structuredBody.component:component6.section
Comments

SHALL contain exactly one [1..1] Physical Exam Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.2.10:2015-08-01) (CONF:1198-28909).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Physical Exam Section)
86. ClinicalDocument.component.structuredBody.component:component7
Slice Namecomponent7
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28910) such that it

Control1..1
88. ClinicalDocument.component.structuredBody.component:component7.section
Comments

SHALL contain exactly one [1..1] Allergies and Intolerances Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.6.1:2015-08-01) (CONF:1198-28911).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Allergies and Intolerances Section)
90. ClinicalDocument.component.structuredBody.component:component8
Slice Namecomponent8
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28912) such that it

Control0..1
92. ClinicalDocument.component.structuredBody.component:component8.section
Comments

SHALL contain exactly one [1..1] Chief Complaint Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) (CONF:1198-28913).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Chief Complaint Section)
94. ClinicalDocument.component.structuredBody.component:component9
Slice Namecomponent9
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28915) such that it

Control0..1
96. ClinicalDocument.component.structuredBody.component:component9.section
Comments

SHALL contain exactly one [1..1] Chief Complaint and Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.13) (CONF:1198-28916).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Chief Complaint and Reason for Visit Section)
98. ClinicalDocument.component.structuredBody.component:component10
Slice Namecomponent10
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28917) such that it

Control0..1
100. ClinicalDocument.component.structuredBody.component:component10.section
Comments

SHALL contain exactly one [1..1] Family History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2015-08-01) (CONF:1198-28918).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Family History Section)
102. ClinicalDocument.component.structuredBody.component:component11
Slice Namecomponent11
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28919) such that it

Control0..1
104. ClinicalDocument.component.structuredBody.component:component11.section
Comments

SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-28920).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(General Status Section)
106. ClinicalDocument.component.structuredBody.component:component12
Slice Namecomponent12
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28921) such that it

Control0..1
108. ClinicalDocument.component.structuredBody.component:component12.section
Comments

SHALL contain exactly one [1..1] Past Medical History (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2015-08-01) (CONF:1198-28922).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Past Medical History)
110. ClinicalDocument.component.structuredBody.component:component13
Slice Namecomponent13
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28923) such that it

Control0..1
112. ClinicalDocument.component.structuredBody.component:component13.section
Comments

SHALL contain exactly one [1..1] Immunizations Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2015-08-01) (CONF:1198-28924).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Immunizations Section)
114. ClinicalDocument.component.structuredBody.component:component14
Slice Namecomponent14
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28925) such that it

Control0..1
116. ClinicalDocument.component.structuredBody.component:component14.section
Comments

SHALL contain exactly one [1..1] Medications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.1.1:2014-06-09) (CONF:1198-28926).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Medications Section)
118. ClinicalDocument.component.structuredBody.component:component15
Slice Namecomponent15
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28928) such that it

Control1..1
120. ClinicalDocument.component.structuredBody.component:component15.section
Comments

SHALL contain exactly one [1..1] Problem Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.5.1:2015-08-01) (CONF:1198-28929).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Problem Section)
122. ClinicalDocument.component.structuredBody.component:component16
Slice Namecomponent16
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28930) such that it

Control0..1
124. ClinicalDocument.component.structuredBody.component:component16.section
Comments

SHALL contain exactly one [1..1] Procedures Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-28931).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedures Section)
126. ClinicalDocument.component.structuredBody.component:component17
Slice Namecomponent17
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28932) such that it

Control0..1
128. ClinicalDocument.component.structuredBody.component:component17.section
Comments

SHALL contain exactly one [1..1] Results Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.3.1:2015-08-01) (CONF:1198-28933).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Results Section)
130. ClinicalDocument.component.structuredBody.component:component18
Slice Namecomponent18
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28934) such that it

Control0..1
132. ClinicalDocument.component.structuredBody.component:component18.section
Comments

SHALL contain exactly one [1..1] Social History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2015-08-01) (CONF:1198-28935).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Social History Section)
134. ClinicalDocument.component.structuredBody.component:component19
Slice Namecomponent19
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28936) such that it

Control0..1
136. ClinicalDocument.component.structuredBody.component:component19.section
Comments

SHALL contain exactly one [1..1] Vital Signs Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.4.1:2015-08-01) (CONF:1198-28937).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Vital Signs Section)
138. ClinicalDocument.component.structuredBody.component:component25
Slice Namecomponent25
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it

Control0..1
140. ClinicalDocument.component.structuredBody.component:component25.section
Comments

SHALL contain exactly one [1..1] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2015-08-01) (CONF:1198-28943).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
142. ClinicalDocument.component.structuredBody.component:component20
Slice Namecomponent20
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28944) such that it

Control0..1
144. ClinicalDocument.component.structuredBody.component:component20.section
Comments

SHALL contain exactly one [1..1] Functional Status Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.14:2014-06-09) (CONF:1198-28945).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Functional Status Section)
146. ClinicalDocument.component.structuredBody.component:component21
Slice Namecomponent21
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30237) such that it

Control0..1
148. ClinicalDocument.component.structuredBody.component:component21.section
Comments

SHALL contain exactly one [1..1] Review of Systems Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.18) (CONF:1198-30238).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Review of Systems Section)
150. ClinicalDocument.component.structuredBody.component:component22
Slice Namecomponent22
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30904) such that it

Control0..1
152. ClinicalDocument.component.structuredBody.component:component22.section
Comments

SHALL contain exactly one [1..1] Medical Equipment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.23:2014-06-09) (CONF:1198-30905).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Medical Equipment Section)
154. ClinicalDocument.component.structuredBody.component:component23
Slice Namecomponent23
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30906) such that it

Control0..1
156. ClinicalDocument.component.structuredBody.component:component23.section
Comments

SHALL contain exactly one [1..1] Mental Status Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.56:2015-08-01) (CONF:1198-30907).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Mental Status Section)
158. ClinicalDocument.component.structuredBody.component:component24
Slice Namecomponent24
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30909) such that it

Control0..1
160. ClinicalDocument.component.structuredBody.component:component24.section
Comments

SHALL contain exactly one [1..1] Nutrition Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.57) (CONF:1198-30910).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Nutrition Section)

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

0. ClinicalDocument
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. ClinicalDocument.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

Comments

SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
4. ClinicalDocument.realmCode.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.

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 ValueUS
6. ClinicalDocument.realmCode.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
8. ClinicalDocument.realmCode.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
10. ClinicalDocument.realmCode.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
12. ClinicalDocument.realmCode.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
14. ClinicalDocument.realmCode.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
16. ClinicalDocument.realmCode.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
18. ClinicalDocument.realmCode.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
20. ClinicalDocument.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.

Comments

SHALL contain exactly one [1..1] typeId (CONF:4537-5361).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
22. ClinicalDocument.typeId.root
Comments

This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).

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.
Fixed Value2.16.840.1.113883.1.3
24. ClinicalDocument.typeId.extension
Definition

An Extension

ShortExtension
Comments

This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).

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.
Fixed ValuePOCD_HD000040
26. ClinicalDocument.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

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
28. ClinicalDocument.templateId:us-realm
Slice Nameus-realm
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

ShorttemplateId
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
30. ClinicalDocument.templateId:us-realm.root
Definition

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:4537-10036).

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.1.1
32. ClinicalDocument.templateId:us-realm.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32503).

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2023-05-01
34. ClinicalDocument.templateId:secondary
Slice Namesecondary
Definition

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

Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
36. ClinicalDocument.templateId:secondary.root
Definition

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.4" (CONF:1198-10040).

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.1.4
38. ClinicalDocument.templateId:secondary.extension
Definition

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

Comments

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2015-08-01
40. ClinicalDocument.id
Comments

SHALL contain exactly one [1..1] id (CONF:4537-5363).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
42. ClinicalDocument.code
ShortThe Consultation Note recommends use of the document type code 11488-4 "Consult Note", with further specification provided by author or performer, setting, or specialty. When pre-coordinated codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Comments

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet ConsultDocumentType http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.11.20.9.31 DYNAMIC (CONF:1198-17176).

Control1..1
BindingThe codes SHALL be taken from ConsultDocumentType
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants4537-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). ()
4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). ()
44. ClinicalDocument.title
ShortThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
Comments

SHALL contain exactly one [1..1] title (CONF:4537-5254).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
46. ClinicalDocument.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-10127: **SHALL** be precise to the day (CONF:81-10127). ()
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). ()
81-10129: **MAY** be precise to the second (CONF:81-10129). ()
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
48. ClinicalDocument.confidentialityCode
Comments

SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:4537-5259).

Control1..1
BindingThe codes SHOULD be taken from HL7 BasicConfidentialityKind
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
50. ClinicalDocument.languageCode
Comments

SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5372).

Control1..1
BindingThe codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
52. ClinicalDocument.recordTarget
Comments

SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
54. ClinicalDocument.recordTarget.patientRole
Comments

Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PatientRole
56. ClinicalDocument.recordTarget.patientRole.id
Comments

This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
58. ClinicalDocument.recordTarget.patientRole.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
60. ClinicalDocument.recordTarget.patientRole.telecom
Comments

This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
62. ClinicalDocument.recordTarget.patientRole.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
64. ClinicalDocument.recordTarget.patientRole.patient
Comments

This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Patient
66. ClinicalDocument.recordTarget.patientRole.patient.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).


A name associated with the individual.

ShortBase for all types and resourcesA name associated with the patient
Comments

This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284).


A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.

Control10..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Patient Name (PTN.US.FIELDED))
Is Modifierfalse
Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). ()
68. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Comments

This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:4537-6394).

Control1..1
BindingThe codes SHALL be taken from Administrative Gender (HL7 V3)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
70. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments

This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants4537-5299: **SHALL** be precise to year (CONF:4537-5299). ()
4537-5300: **SHOULD** be precise to day (CONF:4537-5300). ()
4537-32418: **MAY** be precise to the minute (CONF:4537-32418). ()
72. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Comments

This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:4537-5322).

Control1..1
BindingThe codes SHALL be taken from Race Category Excluding Nulls
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
74. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Comments

This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:4537-5323).

Control1..1
BindingThe codes SHALL be taken from Ethnicity
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
76. ClinicalDocument.author
Comments

SHALL contain at least one [1..*] author (CONF:4537-5444).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
78. ClinicalDocument.author.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-10127: **SHALL** be precise to the day (CONF:81-10127). ()
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). ()
81-10129: **MAY** be precise to the second (CONF:81-10129). ()
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
80. ClinicalDocument.author.assignedAuthor
Comments

Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ()
82. ClinicalDocument.author.assignedAuthor.id
Comments

This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
84. ClinicalDocument.author.assignedAuthor.id:id1
Slice Nameid1
Shortid
Comments

This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
86. ClinicalDocument.author.assignedAuthor.id:id1.root
Definition

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884).

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.4.6
88. ClinicalDocument.author.assignedAuthor.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
90. ClinicalDocument.author.assignedAuthor.telecom
Comments

This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
92. ClinicalDocument.author.assignedAuthor.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
94. ClinicalDocument.informant
Comments

MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
SlicingThis element introduces a set of slices on ClinicalDocument.informant. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ relatedEntity
96. ClinicalDocument.informant:informant1
Slice Nameinformant1
Shortinformant
Comments

MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
98. ClinicalDocument.informant:informant1.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
100. ClinicalDocument.informant:informant1.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants4537-9946: If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). ()
102. ClinicalDocument.informant:informant1.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
104. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
106. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).


A name associated with the person.

ShortBase for all types and resourcesA name associated with the person
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222).


Person may have multiple names with different uses or applicable periods.

Control10..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Requirements

Need to be able to track the person by multiple names. Examples are your official name and a partner name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
108. ClinicalDocument.informant:informant2
Slice Nameinformant2
Shortinformant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
110. ClinicalDocument.informant:informant2.relatedEntity
Comments

SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
112. ClinicalDocument.custodian
Comments

SHALL contain exactly one [1..1] custodian (CONF:4537-5519).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
114. ClinicalDocument.custodian.assignedCustodian
Comments

This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
116. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments

This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
118. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments

This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
120. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
122. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
124. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
126. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
128. ClinicalDocument.authenticator
Comments

MAY contain zero or more [0..*] authenticator (CONF:4537-5607) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
SlicingThis element introduces a set of slices on ClinicalDocument.authenticator. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ ClinicalDocument.signatureCode
  • value @ ClinicalDocument.assignedEntity
  • value @ ClinicalDocument.time
130. ClinicalDocument.authenticator:authenticator1
Slice Nameauthenticator1
Shortauthenticator
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
132. ClinicalDocument.authenticator:authenticator1.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-10127: **SHALL** be precise to the day (CONF:81-10127). ()
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). ()
81-10129: **MAY** be precise to the second (CONF:81-10129). ()
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
134. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments

SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
136. ClinicalDocument.authenticator:authenticator1.signatureCode.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 signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5611).

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 ValueS
138. ClinicalDocument.authenticator:authenticator1.signatureCode.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
140. ClinicalDocument.authenticator:authenticator1.signatureCode.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
142. ClinicalDocument.authenticator:authenticator1.signatureCode.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
144. ClinicalDocument.authenticator:authenticator1.signatureCode.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
146. ClinicalDocument.authenticator:authenticator1.signatureCode.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
148. ClinicalDocument.authenticator:authenticator1.signatureCode.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
150. ClinicalDocument.authenticator:authenticator1.signatureCode.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
152. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
154. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
156. ClinicalDocument.authenticator:authenticator1.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5616).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
158. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments

This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
160. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-8000).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
162. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
164. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).


A name associated with the person.

ShortBase for all types and resourcesA name associated with the person
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625).


Person may have multiple names with different uses or applicable periods.

Control10..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Requirements

Need to be able to track the person by multiple names. Examples are your official name and a partner name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
166. ClinicalDocument.participant
ShortThis participant represents the person to contact for questions about the consult summary. This call back contact individual may be a different person than the individual(s) identified in the author or legalAuthenticator participant.
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). ()
4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). ()
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ ClinicalDocument.typeCode
168. ClinicalDocument.participant.associatedEntity
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
170. ClinicalDocument.participant:participant1
Slice Nameparticipant1
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). ()
4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). ()
172. ClinicalDocument.participant:participant1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="CALLBCK" call back contact (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 DYNAMIC) (CONF:1198-31657).

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 ValueCALLBCK
174. ClinicalDocument.participant:participant1.associatedEntity
Comments

SHALL contain exactly one [1..1] associatedEntity (CONF:1198-31658).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
176. ClinicalDocument.participant:participant1.associatedEntity.classCode
Comments

This associatedEntity SHALL contain exactly one [1..1] @classCode="ASSIGNED" assigned entity (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 DYNAMIC) (CONF:1198-31659).

Control1..1
BindingThe codes SHALL be taken from RoleClassAssociative
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 ValueASSIGNED
178. ClinicalDocument.participant:participant1.associatedEntity.id
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
180. ClinicalDocument.participant:participant1.associatedEntity.addr
Comments

This associatedEntity SHOULD contain zero or more [0..*] addr (CONF:1198-31661).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
182. ClinicalDocument.participant:participant1.associatedEntity.telecom
Comments

This associatedEntity SHALL contain at least one [1..*] telecom (CONF:1198-31662).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
184. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson
Comments

This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:1198-31663).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
186. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.name
Definition

A name associated with the person.

ShortA name associated with the person
Comments

This associatedPerson SHALL contain at least one [1..*] name (CONF:1198-31664).


Person may have multiple names with different uses or applicable periods.

Control10..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName
Is Modifierfalse
Requirements

Need to be able to track the person by multiple names. Examples are your official name and a partner name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. ClinicalDocument.participant:participant1.associatedEntity.scopingOrganization
Comments

This associatedEntity MAY contain zero or one [0..1] scopingOrganization (CONF:1198-31665).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
190. ClinicalDocument.inFulfillmentOf
ShortThe inFulfillmentOf element describes prior orders that are fulfilled (in whole or part) by the service events described in the Consultation Note. For example, a prior order might be the consultation that is being reported in the note.
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
192. ClinicalDocument.inFulfillmentOf.order
Comments

Such inFulfillmentOfs SHALL contain exactly one [1..1] order (CONF:1198-29923).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Order
194. ClinicalDocument.inFulfillmentOf.order.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
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 ValueACT
196. ClinicalDocument.inFulfillmentOf.order.id
ShortWhere a referral is being fulfilled by this consultation, this id would be the same as the id in the Patient Referral Act template.
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
198. ClinicalDocument.componentOf
ShortA Consultation Note is always associated with an encounter; the id element of the encompassingEncounter is required to be present and represents the identifier for the encounter.
Comments

SHALL contain exactly one [1..1] componentOf (CONF:1198-8386).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
200. ClinicalDocument.componentOf.encompassingEncounter
Comments

This componentOf SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-8387).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
202. ClinicalDocument.componentOf.encompassingEncounter.id
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
204. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8389).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time (DT.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
81-10078: **SHALL** be precise to the day (CONF:81-10078). ()
81-10079: **SHOULD** be precise to the minute (CONF:81-10079). ()
81-10080: **MAY** be precise to the second (CONF:81-10080). ()
81-10081: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081). ()
206. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Definition

The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.

Comments

This encompassingEncounter MAY contain zero or one [0..1] responsibleParty (CONF:1198-8391).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Comments

The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). ()
210. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
ShortThe encounterParticipant element represents persons who participated in the encounter and not necessarily the entire episode of care.
Comments

This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8392).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
212. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.assignedEntity
Comments

The encounterParticipant, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32902).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants1198-32906: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32906). ()
214. ClinicalDocument.component
Comments

SHALL contain exactly one [1..1] component (CONF:1198-8397).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component
216. ClinicalDocument.component.structuredBody
Comments

This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-28895).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
Invariants1198-28939: This structuredBody **SHALL NOT** contain an Assessment and Plan Section (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present (CONF:1198-28939). ()
1198-28940: This structuredBody **SHALL NOT** contain a Chief Complaint and Reason for Visit Section (2.16.840.1.113883.10.20.22.2.13) when either a Chief Complaint Section (1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) or a Reason for Visit Section (2.16.840.1.113883.10.20.22.2.12) is present (CONF:1198-28940). ()
1198-9504: **SHALL** include a Reason for Referral or Reason for Visit section (CONF:1198-9504). ()
1198-9501: **SHALL** include an Assessment and Plan Section, or both an Assessment Section and a Plan of Treatment Section (CONF:1198-9501). ()
218. ClinicalDocument.component.structuredBody.component
Control5..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ section
220. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section
222. ClinicalDocument.component.structuredBody.component:component1
Slice Namecomponent1
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28896) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. ClinicalDocument.component.structuredBody.component:component1.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

The component, if present, SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-28897).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Assessment Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
226. ClinicalDocument.component.structuredBody.component:component2
Slice Namecomponent2
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28898) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
228. ClinicalDocument.component.structuredBody.component:component2.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Assessment and Plan Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.9:2014-06-09) (CONF:1198-28899).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Assessment and Plan Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
230. ClinicalDocument.component.structuredBody.component:component3
Slice Namecomponent3
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28900) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
232. ClinicalDocument.component.structuredBody.component:component3.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-28901).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. ClinicalDocument.component.structuredBody.component:component4
Slice Namecomponent4
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28904) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. ClinicalDocument.component.structuredBody.component:component4.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.12) (CONF:1198-28905).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Reason for Visit Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. ClinicalDocument.component.structuredBody.component:component5
Slice Namecomponent5
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28906) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. ClinicalDocument.component.structuredBody.component:component5.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-28907).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(History of Present Illness Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. ClinicalDocument.component.structuredBody.component:component6
Slice Namecomponent6
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28908) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. ClinicalDocument.component.structuredBody.component:component6.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Physical Exam Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.2.10:2015-08-01) (CONF:1198-28909).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Physical Exam Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
246. ClinicalDocument.component.structuredBody.component:component7
Slice Namecomponent7
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28910) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
248. ClinicalDocument.component.structuredBody.component:component7.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Allergies and Intolerances Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.6.1:2015-08-01) (CONF:1198-28911).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Allergies and Intolerances Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. ClinicalDocument.component.structuredBody.component:component8
Slice Namecomponent8
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28912) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. ClinicalDocument.component.structuredBody.component:component8.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Chief Complaint Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) (CONF:1198-28913).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Chief Complaint Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. ClinicalDocument.component.structuredBody.component:component9
Slice Namecomponent9
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28915) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
256. ClinicalDocument.component.structuredBody.component:component9.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Chief Complaint and Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.13) (CONF:1198-28916).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Chief Complaint and Reason for Visit Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. ClinicalDocument.component.structuredBody.component:component10
Slice Namecomponent10
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28917) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. ClinicalDocument.component.structuredBody.component:component10.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Family History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2015-08-01) (CONF:1198-28918).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Family History Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
262. ClinicalDocument.component.structuredBody.component:component11
Slice Namecomponent11
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28919) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
264. ClinicalDocument.component.structuredBody.component:component11.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-28920).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(General Status Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. ClinicalDocument.component.structuredBody.component:component12
Slice Namecomponent12
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28921) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. ClinicalDocument.component.structuredBody.component:component12.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Past Medical History (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2015-08-01) (CONF:1198-28922).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Past Medical History)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. ClinicalDocument.component.structuredBody.component:component13
Slice Namecomponent13
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28923) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. ClinicalDocument.component.structuredBody.component:component13.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Immunizations Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2015-08-01) (CONF:1198-28924).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Immunizations Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. ClinicalDocument.component.structuredBody.component:component14
Slice Namecomponent14
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28925) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. ClinicalDocument.component.structuredBody.component:component14.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Medications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.1.1:2014-06-09) (CONF:1198-28926).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Medications Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. ClinicalDocument.component.structuredBody.component:component15
Slice Namecomponent15
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28928) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
280. ClinicalDocument.component.structuredBody.component:component15.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Problem Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.5.1:2015-08-01) (CONF:1198-28929).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Problem Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. ClinicalDocument.component.structuredBody.component:component16
Slice Namecomponent16
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28930) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
284. ClinicalDocument.component.structuredBody.component:component16.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Procedures Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-28931).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedures Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
286. ClinicalDocument.component.structuredBody.component:component17
Slice Namecomponent17
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28932) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
288. ClinicalDocument.component.structuredBody.component:component17.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Results Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.3.1:2015-08-01) (CONF:1198-28933).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Results Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
290. ClinicalDocument.component.structuredBody.component:component18
Slice Namecomponent18
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28934) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
292. ClinicalDocument.component.structuredBody.component:component18.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Social History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2015-08-01) (CONF:1198-28935).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Social History Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. ClinicalDocument.component.structuredBody.component:component19
Slice Namecomponent19
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28936) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
296. ClinicalDocument.component.structuredBody.component:component19.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Vital Signs Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.4.1:2015-08-01) (CONF:1198-28937).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Vital Signs Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
298. ClinicalDocument.component.structuredBody.component:component25
Slice Namecomponent25
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
300. ClinicalDocument.component.structuredBody.component:component25.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2015-08-01) (CONF:1198-28943).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
302. ClinicalDocument.component.structuredBody.component:component20
Slice Namecomponent20
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28944) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. ClinicalDocument.component.structuredBody.component:component20.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Functional Status Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.14:2014-06-09) (CONF:1198-28945).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Functional Status Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. ClinicalDocument.component.structuredBody.component:component21
Slice Namecomponent21
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30237) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
308. ClinicalDocument.component.structuredBody.component:component21.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Review of Systems Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.18) (CONF:1198-30238).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Review of Systems Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. ClinicalDocument.component.structuredBody.component:component22
Slice Namecomponent22
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30904) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. ClinicalDocument.component.structuredBody.component:component22.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Medical Equipment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.23:2014-06-09) (CONF:1198-30905).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Medical Equipment Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. ClinicalDocument.component.structuredBody.component:component23
Slice Namecomponent23
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30906) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
316. ClinicalDocument.component.structuredBody.component:component23.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Mental Status Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.56:2015-08-01) (CONF:1198-30907).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Mental Status Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
318. ClinicalDocument.component.structuredBody.component:component24
Slice Namecomponent24
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30909) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
320. ClinicalDocument.component.structuredBody.component:component24.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Nutrition Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.57) (CONF:1198-30910).

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

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

0. ClinicalDocument
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. ClinicalDocument.classCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActClass
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 ValueDOCCLIN
4. ClinicalDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. ClinicalDocument.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

Comments

SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. ClinicalDocument.realmCode.nullFlavor
Definition

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

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

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 ValueUS
12. ClinicalDocument.realmCode.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
14. ClinicalDocument.realmCode.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
16. ClinicalDocument.realmCode.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
18. ClinicalDocument.realmCode.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
20. ClinicalDocument.realmCode.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.
22. ClinicalDocument.realmCode.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.
24. ClinicalDocument.realmCode.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
26. ClinicalDocument.realmCode.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
28. ClinicalDocument.realmCode.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
30. ClinicalDocument.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.

Comments

SHALL contain exactly one [1..1] typeId (CONF:4537-5361).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
32. ClinicalDocument.typeId.root
Comments

This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).

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.
Fixed Value2.16.840.1.113883.1.3
34. ClinicalDocument.typeId.extension
Definition

An Extension

ShortExtension
Comments

This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).

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.
Fixed ValuePOCD_HD000040
36. ClinicalDocument.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

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
38. ClinicalDocument.templateId:us-realm
Slice Nameus-realm
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

ShorttemplateId
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
40. ClinicalDocument.templateId:us-realm.nullFlavor
Definition

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

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

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.1" (CONF:4537-10036).

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.1.1
48. ClinicalDocument.templateId:us-realm.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32503).

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2023-05-01
50. ClinicalDocument.templateId:secondary
Slice Namesecondary
Definition

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

Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
52. ClinicalDocument.templateId:secondary.nullFlavor
Definition

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

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

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.4" (CONF:1198-10040).

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.1.4
60. ClinicalDocument.templateId:secondary.extension
Definition

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

Comments

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2015-08-01
62. ClinicalDocument.id
Comments

SHALL contain exactly one [1..1] id (CONF:4537-5363).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
64. ClinicalDocument.code
ShortThe Consultation Note recommends use of the document type code 11488-4 "Consult Note", with further specification provided by author or performer, setting, or specialty. When pre-coordinated codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Comments

SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet ConsultDocumentType http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.11.20.9.31 DYNAMIC (CONF:1198-17176).

Control1..1
BindingThe codes SHALL be taken from ConsultDocumentType
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants4537-9992: This code **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992). ()
4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). ()
66. ClinicalDocument.title
ShortThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
Comments

SHALL contain exactly one [1..1] title (CONF:4537-5254).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
68. ClinicalDocument.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-10127: **SHALL** be precise to the day (CONF:81-10127). ()
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). ()
81-10129: **MAY** be precise to the second (CONF:81-10129). ()
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
70. ClinicalDocument.confidentialityCode
Comments

SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:4537-5259).

Control1..1
BindingThe codes SHOULD be taken from HL7 BasicConfidentialityKind
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
72. ClinicalDocument.languageCode
Comments

SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5372).

Control1..1
BindingThe codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
74. ClinicalDocument.setId
Comments

MAY contain zero or one [0..1] setId (CONF:4537-5261).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). ()
76. ClinicalDocument.versionNumber
Comments

MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
Invariants4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ()
78. ClinicalDocument.copyTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
80. ClinicalDocument.recordTarget
Comments

SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
82. ClinicalDocument.recordTarget.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
84. ClinicalDocument.recordTarget.typeCode
Control0..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 ValueRCT
86. ClinicalDocument.recordTarget.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
88. ClinicalDocument.recordTarget.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
90. ClinicalDocument.recordTarget.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
92. ClinicalDocument.recordTarget.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
94. ClinicalDocument.recordTarget.patientRole
Comments

Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PatientRole
96. ClinicalDocument.recordTarget.patientRole.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassRelationshipFormal
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 ValuePAT
98. ClinicalDocument.recordTarget.patientRole.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
100. ClinicalDocument.recordTarget.patientRole.id
Comments

This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
102. ClinicalDocument.recordTarget.patientRole.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.
104. ClinicalDocument.recordTarget.patientRole.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
106. ClinicalDocument.recordTarget.patientRole.telecom
Comments

This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
108. ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
110. ClinicalDocument.recordTarget.patientRole.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
112. ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
114. ClinicalDocument.recordTarget.patientRole.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
116. ClinicalDocument.recordTarget.patientRole.patient
Comments

This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Patient
118. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
120. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
122. ClinicalDocument.recordTarget.patientRole.patient.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. ClinicalDocument.recordTarget.patientRole.patient.id
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
126. ClinicalDocument.recordTarget.patientRole.patient.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). ()
128. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
130. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Comments

This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:4537-6394).

Control1..1
BindingThe codes SHALL be taken from Administrative Gender (HL7 V3)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
132. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments

This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants4537-5299: **SHALL** be precise to year (CONF:4537-5299). ()
4537-5300: **SHOULD** be precise to day (CONF:4537-5300). ()
4537-32418: **MAY** be precise to the minute (CONF:4537-32418). ()
134. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Shortsdtc:deceasedInd
Comments

This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd.
Invariants4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993). ()
136. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Shortsdtc:deceasedTime
Comments

This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime.
138. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime.nullFlavor
Definition

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

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

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Comments

The sdtc:deceasedTime, if present, SHOULD contain zero or one [0..1] @value (CONF:4537-32989).

Control0..1
Typestring(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
Invariants4537-32991: **SHALL** be precise to to the year (CONF:4537-32991). ()
4537-32992: **SHOULD** be precise to the day (CONF:4537-32992). ()
142. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd.
144. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber.
146. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
Comments

This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303).

Control0..1
BindingThe codes SHALL be taken from Marital Status
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
148. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
Comments

This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317).

Control0..1
BindingThe codes SHALL be taken from Religious Affiliation
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
150. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Comments

This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:4537-5322).

Control1..1
BindingThe codes SHALL be taken from Race Category Excluding Nulls
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
152. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
ShortThe sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.
Comments

This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race Value Set urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:4537-7263).

Control0..*
BindingThe codes SHALL be taken from Race Value Set
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 nameraceCode.
Invariants4537-31347: If sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347). ()
154. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Comments

This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:4537-5323).

Control1..1
BindingThe codes SHALL be taken from Ethnicity
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
156. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
ShortethnicGroupCode
Comments

This patient MAY contain zero or more [0..*] ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:4537-32901).

Control0..*
BindingThe codes SHALL be taken from Detailed Ethnicity
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 nameethnicGroupCode.
158. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments

This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Guardian
160. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAgent
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 ValueGUARD
162. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
164. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
166. ClinicalDocument.recordTarget.patientRole.patient.guardian.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.
168. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
Comments

The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-5326).

Control0..1
BindingThe codes SHALL be taken from Personal And Legal Relationship Role Type
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
170. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
172. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments

The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
174. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
176. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
178. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
180. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
182. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments

The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
184. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
186. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
188. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
190. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
192. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
194. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
196. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments

This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Birthplace
198. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassPassive
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 ValueBIRTHPL
200. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
202. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments

The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Place
204. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassPlace
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 ValuePLC
206. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
208. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
210. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
212. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments

This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet StateValueSet 2.16.840.1.113883.3.88.12.80.1 *DYNAMIC* (CONF:4537-5402). ()
4537-5403: If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403). ()
214. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor
Definition

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

ShortPrimitive Type code
Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
LabelExceptional Value Detail
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
cs-pattern: cs attributes must not contain any whitespace (matches('^[^\\s]+$'))
216. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered
Definition

A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.

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.
LabelIs Not Ordered
218. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use
Definition

A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.

Control0..*
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.
LabelUse Code
220. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter
Definition

Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
222. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDEL
224. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country
Definition

Country

Comments

This addr SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:4537-5404).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
226. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCNT
228. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state
Definition

A sub-unit of a country with limited sovereignty in a federally organized country.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
230. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTA
232. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county
Definition

A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
234. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCPA
236. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city
Definition

The name of the city, town, village, or other community or delivery center

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
238. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCTY
240. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
242. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType
Definition

Specifies the type of the address part

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.
Fixed ValueZIP
244. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine
Definition

Street address line

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
246. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSAL
248. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber
Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
250. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType
Definition

Specifies the type of the address part

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.
Fixed ValueBNR
252. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
254. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType
Definition

Specifies the type of the address part

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.
Fixed ValueBNN
256. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction
Definition

Direction (e.g., N, S, W, E)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
258. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDIR
260. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName
Definition

Name of a roadway or artery recognized by a municipality (including street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
262. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTR
264. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase
Definition

The base name of a roadway or artery recognized by a municipality (excluding street type and direction)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
266. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTB
268. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType
Definition

The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
270. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTTYP
272. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator
Definition

This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
274. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType
Definition

Specifies the type of the address part

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.
Fixed ValueADL
276. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID
Definition

The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
278. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType
Definition

Specifies the type of the address part

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.
Fixed ValueUNID
280. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType
Definition

Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
282. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType
Definition

Specifies the type of the address part

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.
Fixed ValueUNIT
284. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf
Definition

The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
286. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCAR
288. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract
Definition

A geographic sub-unit delineated for demographic purposes.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
290. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCEN
292. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine
Definition

A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
294. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDAL
296. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType
Definition

Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
298. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDINST
300. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea
Definition

The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
302. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDINSTA
304. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier
Definition

A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
306. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDINSTQ
308. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode
Definition

Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
310. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDMOD
312. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier
Definition

Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
314. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDMODID
316. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix
Definition

Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
318. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

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.
Fixed ValueBNS
320. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox
Definition

A numbered box located in a post station.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
322. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType
Definition

Specifies the type of the address part

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.
Fixed ValuePOB
324. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct
Definition

A subsection of a municipality

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
326. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType
Definition

Specifies the type of the address part

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.
Fixed ValuePRE
328. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other
Definition

Textual representation of (part of) the address

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.
330. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod
Definition

A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
332. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments

This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:4537-5406).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
334. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
336. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Comments

The languageCommunication, if present, SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet Language urn:oid:2.16.840.1.113883.1.11.11526 DYNAMIC (CONF:4537-5407).

Control1..1
BindingThe codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
338. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode
Comments

The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:4537-5409).

Control0..1
BindingThe codes SHALL be taken from LanguageAbilityMode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
340. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
Comments

The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:4537-9965).

Control0..1
BindingThe codes SHALL be taken from LanguageAbilityProficiency
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
342. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Comments

The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
344. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments

This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
346. ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
348. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
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 ValueORG
350. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
352. ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
354. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
356. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
358. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
360. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor
Definition

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

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

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16820).

Control0..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.4.6
368. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
Definition

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

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.
LabelExtension
370. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
372. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
374. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
376. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
378. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
380. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7994).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
382. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5422).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
384. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
386. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
388. ClinicalDocument.author
Comments

SHALL contain at least one [1..*] author (CONF:4537-5444).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
390. ClinicalDocument.author.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
392. ClinicalDocument.author.typeCode
Control0..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 ValueAUT
394. ClinicalDocument.author.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
396. ClinicalDocument.author.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
398. ClinicalDocument.author.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
400. ClinicalDocument.author.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
402. ClinicalDocument.author.functionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
404. ClinicalDocument.author.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

Such authors SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-10127: **SHALL** be precise to the day (CONF:81-10127). ()
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). ()
81-10129: **MAY** be precise to the second (CONF:81-10129). ()
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
406. ClinicalDocument.author.assignedAuthor
Comments

Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ()
408. ClinicalDocument.author.assignedAuthor.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
410. ClinicalDocument.author.assignedAuthor.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
412. ClinicalDocument.author.assignedAuthor.id
Comments

This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
414. ClinicalDocument.author.assignedAuthor.id:id1
Slice Nameid1
Shortid
Comments

This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
416. ClinicalDocument.author.assignedAuthor.id:id1.nullFlavor
Definition

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

Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4537-32883).

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
Fixed ValueUNK
418. ClinicalDocument.author.assignedAuthor.id:id1.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
420. ClinicalDocument.author.assignedAuthor.id:id1.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
422. ClinicalDocument.author.assignedAuthor.id:id1.root
Definition

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884).

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.4.6
424. ClinicalDocument.author.assignedAuthor.id:id1.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4537-32885).

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.
LabelExtension
426. ClinicalDocument.author.assignedAuthor.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.
428. ClinicalDocument.author.assignedAuthor.code
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
430. ClinicalDocument.author.assignedAuthor.code.nullFlavor
Definition

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

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

The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-16788).

Control1..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
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
434. ClinicalDocument.author.assignedAuthor.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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
436. ClinicalDocument.author.assignedAuthor.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
438. ClinicalDocument.author.assignedAuthor.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
440. ClinicalDocument.author.assignedAuthor.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
442. ClinicalDocument.author.assignedAuthor.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.
444. ClinicalDocument.author.assignedAuthor.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.
446. ClinicalDocument.author.assignedAuthor.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
448. ClinicalDocument.author.assignedAuthor.code.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
450. ClinicalDocument.author.assignedAuthor.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
452. ClinicalDocument.author.assignedAuthor.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
454. ClinicalDocument.author.assignedAuthor.telecom
Comments

This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
456. ClinicalDocument.author.assignedAuthor.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
458. ClinicalDocument.author.assignedAuthor.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
460. ClinicalDocument.author.assignedAuthor.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
462. ClinicalDocument.author.assignedAuthor.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
464. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments

This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4537-5430).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
466. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
468. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
470. ClinicalDocument.author.assignedAuthor.assignedPerson.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
472. ClinicalDocument.author.assignedAuthor.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-16789).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
474. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
476. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments

This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:4537-16783).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
478. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassDevice
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 ValueDEV
480. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
482. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
484. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from EntityCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
486. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments

The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).

Control1..1
BindingFor example codes, see Manufacturer Model Name Example
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
488. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments

The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).

Control1..1
BindingFor example codes, see Software Name Example
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
490. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
492. ClinicalDocument.author.assignedAuthor.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
494. ClinicalDocument.dataEnterer
Comments

MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
496. ClinicalDocument.dataEnterer.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
498. ClinicalDocument.dataEnterer.typeCode
Control0..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 ValueENT
500. ClinicalDocument.dataEnterer.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
502. ClinicalDocument.dataEnterer.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
504. ClinicalDocument.dataEnterer.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
506. ClinicalDocument.dataEnterer.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
508. ClinicalDocument.dataEnterer.time
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
510. ClinicalDocument.dataEnterer.assignedEntity
Comments

The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
512. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
514. ClinicalDocument.dataEnterer.assignedEntity.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
516. ClinicalDocument.dataEnterer.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
518. ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor
Definition

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

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

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16821).

Control0..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.4.6
526. ClinicalDocument.dataEnterer.assignedEntity.id.extension
Definition

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

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.
LabelExtension
528. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
Definition

Element AssignedEntity.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.
530. ClinicalDocument.dataEnterer.assignedEntity.code
Comments

This assignedEntity 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:4537-32173).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
532. ClinicalDocument.dataEnterer.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5460).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
534. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments

This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
536. ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
538. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
540. ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
542. ClinicalDocument.dataEnterer.assignedEntity.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7996).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
544. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
546. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
548. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
550. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
552. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5470).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
554. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
556. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
558. ClinicalDocument.informant
Comments

MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
SlicingThis element introduces a set of slices on ClinicalDocument.informant. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ relatedEntity
560. ClinicalDocument.informant:informant1
Slice Nameinformant1
Shortinformant
Comments

MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
562. ClinicalDocument.informant:informant1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
564. ClinicalDocument.informant:informant1.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
566. ClinicalDocument.informant:informant1.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
568. ClinicalDocument.informant:informant1.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
570. ClinicalDocument.informant:informant1.typeCode
Control0..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 ValueINF
572. ClinicalDocument.informant:informant1.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
574. ClinicalDocument.informant:informant1.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
576. ClinicalDocument.informant:informant1.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
578. ClinicalDocument.informant:informant1.assignedEntity.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
580. ClinicalDocument.informant:informant1.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants4537-9946: If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946). ()
582. ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy
Definition

Element AssignedEntity.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.
584. ClinicalDocument.informant:informant1.assignedEntity.code
Comments

This assignedEntity 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:4537-32174).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
586. ClinicalDocument.informant:informant1.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
588. ClinicalDocument.informant:informant1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
590. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
592. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
594. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
596. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.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
598. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
600. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
602. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
604. ClinicalDocument.informant:informant1.relatedEntity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
606. ClinicalDocument.informant:informant2
Slice Nameinformant2
Shortinformant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
608. ClinicalDocument.informant:informant2.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
610. ClinicalDocument.informant:informant2.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
612. ClinicalDocument.informant:informant2.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
614. ClinicalDocument.informant:informant2.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
616. ClinicalDocument.informant:informant2.typeCode
Control0..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 ValueINF
618. ClinicalDocument.informant:informant2.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
620. ClinicalDocument.informant:informant2.assignedEntity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
622. ClinicalDocument.informant:informant2.relatedEntity
Comments

SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
624. ClinicalDocument.custodian
Comments

SHALL contain exactly one [1..1] custodian (CONF:4537-5519).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
626. ClinicalDocument.custodian.nullFlavor
Definition

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

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

This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
638. ClinicalDocument.custodian.assignedCustodian.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
640. ClinicalDocument.custodian.assignedCustodian.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
642. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments

This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
644. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
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 ValueORG
646. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
648. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
650. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments

This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
652. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor
Definition

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

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

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16822).

Control0..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.4.6
660. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
Definition

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

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.
LabelExtension
662. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
664. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
666. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
668. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
670. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
672. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
674. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
676. ClinicalDocument.informationRecipient
Comments

MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
678. ClinicalDocument.informationRecipient.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
680. ClinicalDocument.informationRecipient.typeCode
Control0..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.
Default ValuePRCP
682. ClinicalDocument.informationRecipient.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
684. ClinicalDocument.informationRecipient.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
686. ClinicalDocument.informationRecipient.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
688. ClinicalDocument.informationRecipient.intendedRecipient
Comments

The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
690. ClinicalDocument.informationRecipient.intendedRecipient.classCode
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.
Default ValueASSIGNED
692. ClinicalDocument.informationRecipient.intendedRecipient.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
694. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments

This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
696. ClinicalDocument.informationRecipient.intendedRecipient.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.
698. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
700. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
702. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments

This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
704. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
706. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
708. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
710. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5568).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
712. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
714. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments

This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
716. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
718. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
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 ValueORG
720. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
722. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
724. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
726. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
728. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
730. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Comments

The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
732. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
734. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
736. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
738. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
740. ClinicalDocument.legalAuthenticator
Comments

SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
742. ClinicalDocument.legalAuthenticator.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
744. ClinicalDocument.legalAuthenticator.typeCode
Control0..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 ValueLA
746. ClinicalDocument.legalAuthenticator.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
748. ClinicalDocument.legalAuthenticator.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
750. ClinicalDocument.legalAuthenticator.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
752. ClinicalDocument.legalAuthenticator.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
754. ClinicalDocument.legalAuthenticator.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-10127: **SHALL** be precise to the day (CONF:81-10127). ()
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). ()
81-10129: **MAY** be precise to the second (CONF:81-10129). ()
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
756. ClinicalDocument.legalAuthenticator.signatureCode
Comments

The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
758. ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
760. ClinicalDocument.legalAuthenticator.signatureCode.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 signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5584).

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 ValueS
762. ClinicalDocument.legalAuthenticator.signatureCode.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
764. ClinicalDocument.legalAuthenticator.signatureCode.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
766. ClinicalDocument.legalAuthenticator.signatureCode.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
768. ClinicalDocument.legalAuthenticator.signatureCode.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
770. ClinicalDocument.legalAuthenticator.signatureCode.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.
772. ClinicalDocument.legalAuthenticator.signatureCode.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.
774. ClinicalDocument.legalAuthenticator.signatureCode.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
776. ClinicalDocument.legalAuthenticator.signatureCode.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
778. ClinicalDocument.legalAuthenticator.signatureCode.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
780. ClinicalDocument.legalAuthenticator.sdtcSignatureText
ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
Comments

The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
782. ClinicalDocument.legalAuthenticator.assignedEntity
Comments

The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
784. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
786. ClinicalDocument.legalAuthenticator.assignedEntity.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
788. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
790. ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor
Definition

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

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

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

Comments

Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823).

Control0..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.4.6
798. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition

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

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.
LabelExtension
800. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Definition

Element AssignedEntity.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.
802. ClinicalDocument.legalAuthenticator.assignedEntity.code
Comments

This assignedEntity 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:4537-17000).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
804. ClinicalDocument.legalAuthenticator.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5589).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
806. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments

This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
808. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
810. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
812. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
814. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7999).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
816. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
818. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
820. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
822. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
824. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5598).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
826. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
828. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
830. ClinicalDocument.authenticator
Comments

MAY contain zero or more [0..*] authenticator (CONF:4537-5607) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
SlicingThis element introduces a set of slices on ClinicalDocument.authenticator. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ ClinicalDocument.signatureCode
  • value @ ClinicalDocument.assignedEntity
  • value @ ClinicalDocument.time
832. ClinicalDocument.authenticator:authenticator1
Slice Nameauthenticator1
Shortauthenticator
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
834. ClinicalDocument.authenticator:authenticator1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
836. ClinicalDocument.authenticator:authenticator1.typeCode
Control0..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 ValueAUTHEN
838. ClinicalDocument.authenticator:authenticator1.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
840. ClinicalDocument.authenticator:authenticator1.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
842. ClinicalDocument.authenticator:authenticator1.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
844. ClinicalDocument.authenticator:authenticator1.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] US Realm Date and Time (DTM.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-10127: **SHALL** be precise to the day (CONF:81-10127). ()
81-10128: **SHOULD** be precise to the minute (CONF:81-10128). ()
81-10129: **MAY** be precise to the second (CONF:81-10129). ()
81-10130: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130). ()
846. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments

SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
848. ClinicalDocument.authenticator:authenticator1.signatureCode.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
850. ClinicalDocument.authenticator:authenticator1.signatureCode.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 signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5611).

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 ValueS
852. ClinicalDocument.authenticator:authenticator1.signatureCode.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
854. ClinicalDocument.authenticator:authenticator1.signatureCode.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
856. ClinicalDocument.authenticator:authenticator1.signatureCode.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
858. ClinicalDocument.authenticator:authenticator1.signatureCode.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
860. ClinicalDocument.authenticator:authenticator1.signatureCode.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.
862. ClinicalDocument.authenticator:authenticator1.signatureCode.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.
864. ClinicalDocument.authenticator:authenticator1.signatureCode.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
866. ClinicalDocument.authenticator:authenticator1.signatureCode.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
868. ClinicalDocument.authenticator:authenticator1.signatureCode.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
870. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Definition

Element Authenticator.sdtcSignatureText

ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.
Comments

MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
872. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
874. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
876. ClinicalDocument.authenticator:authenticator1.assignedEntity.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
878. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
880. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.nullFlavor
Definition

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

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

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824).

Control0..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.4.6
888. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension
Definition

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

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.
LabelExtension
890. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy
Definition

Element AssignedEntity.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.
892. ClinicalDocument.authenticator:authenticator1.assignedEntity.code
Comments

This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
894. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.nullFlavor
Definition

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

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

The code, if present, 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:4537-16826).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
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
898. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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
900. ClinicalDocument.authenticator:authenticator1.assignedEntity.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
902. ClinicalDocument.authenticator:authenticator1.assignedEntity.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
904. ClinicalDocument.authenticator:authenticator1.assignedEntity.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
906. ClinicalDocument.authenticator:authenticator1.assignedEntity.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.
908. ClinicalDocument.authenticator:authenticator1.assignedEntity.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.
910. ClinicalDocument.authenticator:authenticator1.assignedEntity.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
912. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.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
914. ClinicalDocument.authenticator:authenticator1.assignedEntity.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
916. ClinicalDocument.authenticator:authenticator1.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5616).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). ()
918. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments

This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
920. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
922. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
924. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
926. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-8000).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
928. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
930. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
932. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
934. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.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
936. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pn-no-ls: No PN name part may have a qualifier of LS. ((delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). ()
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). ()
938. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
940. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
942. ClinicalDocument.participant
ShortThis participant represents the person to contact for questions about the consult summary. This call back contact individual may be a different person than the individual(s) identified in the author or legalAuthenticator participant.
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). ()
4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). ()
SlicingThis element introduces a set of slices on ClinicalDocument.participant. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ ClinicalDocument.typeCode
944. ClinicalDocument.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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
946. ClinicalDocument.participant.typeCode
Control0..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.
948. ClinicalDocument.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
950. ClinicalDocument.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
952. ClinicalDocument.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
954. ClinicalDocument.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
956. ClinicalDocument.participant.functionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
958. ClinicalDocument.participant.time
Comments

MAY contain zero or one [0..1] time (CONF:4537-10004).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
960. ClinicalDocument.participant.associatedEntity
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
962. ClinicalDocument.participant:participant1
Slice Nameparticipant1
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). ()
4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). ()
964. ClinicalDocument.participant:participant1.nullFlavor
Definition

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

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

SHALL contain exactly one [1..1] @typeCode="CALLBCK" call back contact (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 DYNAMIC) (CONF:1198-31657).

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 ValueCALLBCK
968. ClinicalDocument.participant:participant1.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
970. ClinicalDocument.participant:participant1.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
972. ClinicalDocument.participant:participant1.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
974. ClinicalDocument.participant:participant1.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
976. ClinicalDocument.participant:participant1.functionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
978. ClinicalDocument.participant:participant1.time
Comments

MAY contain zero or one [0..1] time (CONF:4537-10004).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
980. ClinicalDocument.participant:participant1.associatedEntity
Comments

SHALL contain exactly one [1..1] associatedEntity (CONF:1198-31658).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
982. ClinicalDocument.participant:participant1.associatedEntity.classCode
Comments

This associatedEntity SHALL contain exactly one [1..1] @classCode="ASSIGNED" assigned entity (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 DYNAMIC) (CONF:1198-31659).

Control1..1
BindingThe codes SHALL be taken from RoleClassAssociative
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 ValueASSIGNED
984. ClinicalDocument.participant:participant1.associatedEntity.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
986. ClinicalDocument.participant:participant1.associatedEntity.id
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
988. ClinicalDocument.participant:participant1.associatedEntity.sdtcIdentifiedBy
Definition

Element AssociatedEntity.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.
990. ClinicalDocument.participant:participant1.associatedEntity.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
992. ClinicalDocument.participant:participant1.associatedEntity.addr
Comments

This associatedEntity SHOULD contain zero or more [0..*] addr (CONF:1198-31661).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
994. ClinicalDocument.participant:participant1.associatedEntity.telecom
Comments

This associatedEntity SHALL contain at least one [1..*] telecom (CONF:1198-31662).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
996. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson
Comments

This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:1198-31663).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
998. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
1000. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1002. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.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
1004. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.name
Comments

This associatedPerson SHALL contain at least one [1..*] name (CONF:1198-31664).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
1006. ClinicalDocument.participant:participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
1008. ClinicalDocument.participant:participant1.associatedEntity.scopingOrganization
Comments

This associatedEntity MAY contain zero or one [0..1] scopingOrganization (CONF:1198-31665).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1010. ClinicalDocument.inFulfillmentOf
ShortThe inFulfillmentOf element describes prior orders that are fulfilled (in whole or part) by the service events described in the Consultation Note. For example, a prior order might be the consultation that is being reported in the note.
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
1012. ClinicalDocument.inFulfillmentOf.nullFlavor
Definition

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

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

Such inFulfillmentOfs SHALL contain exactly one [1..1] order (CONF:1198-29923).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Order
1024. ClinicalDocument.inFulfillmentOf.order.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
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 ValueACT
1026. ClinicalDocument.inFulfillmentOf.order.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMoodIntent
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
1028. ClinicalDocument.inFulfillmentOf.order.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
1030. ClinicalDocument.inFulfillmentOf.order.id
ShortWhere a referral is being fulfilled by this consultation, this id would be the same as the id in the Patient Referral Act template.
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1032. ClinicalDocument.inFulfillmentOf.order.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1034. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1036. ClinicalDocument.documentationOf
Comments

MAY contain zero or more [0..*] documentationOf (CONF:4537-14835).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
1038. ClinicalDocument.documentationOf.nullFlavor
Definition

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

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

The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:4537-14836).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
1050. ClinicalDocument.documentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
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 ValueACT
1052. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
1054. ClinicalDocument.documentationOf.serviceEvent.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
1056. ClinicalDocument.documentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1058. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1060. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments

This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:4537-14837).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1062. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavor
Definition

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

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

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
Typestring(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
1066. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
BindingThe codes SHALL be taken from SetOperator
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 ValueI
1068. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

Comments

This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
1070. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
LabelCentral Value
1072. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
LabelWidth
1074. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
1076. ClinicalDocument.documentationOf.serviceEvent.performer
Comments

This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
1078. ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1080. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments

The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840).

Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
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.
1082. ClinicalDocument.documentationOf.serviceEvent.performer.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
1084. ClinicalDocument.documentationOf.serviceEvent.performer.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
1086. ClinicalDocument.documentationOf.serviceEvent.performer.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
1088. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments

The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1090. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor
Definition

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

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

The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
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
1094. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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
1096. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
1098. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
1100. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
1102. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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.
1104. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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.
1106. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
1108. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
1110. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
1112. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1114. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments

The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1116. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
1118. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
1120. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1122. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor
Definition

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

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

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847).

Control0..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.4.6
1130. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension
Definition

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

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.
LabelExtension
1132. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Definition

Element AssignedEntity.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.
1134. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Comments

This assignedEntity SHOULD 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:4537-14842).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1136. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
1138. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
1140. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
1142. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1144. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
1146. ClinicalDocument.authorization
Comments

MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
1148. ClinicalDocument.authorization.nullFlavor
Definition

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

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

SHALL contain exactly one [1..1] consent (CONF:4537-16793).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Consent
1160. ClinicalDocument.authorization.consent.classCode
Control0..1
BindingThe codes SHALL be taken from ActClass
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 ValueCONS
1162. ClinicalDocument.authorization.consent.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
1164. ClinicalDocument.authorization.consent.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
1166. ClinicalDocument.authorization.consent.id
Comments

This consent MAY contain zero or more [0..*] id (CONF:4537-16794).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1168. ClinicalDocument.authorization.consent.code
ShortThe type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.
Comments

This consent MAY contain zero or one [0..1] code (CONF:4537-16795).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1170. ClinicalDocument.authorization.consent.statusCode
Comments

This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
1172. ClinicalDocument.authorization.consent.statusCode.code
Comments

This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Valuecompleted
1174. ClinicalDocument.componentOf
ShortA Consultation Note is always associated with an encounter; the id element of the encompassingEncounter is required to be present and represents the identifier for the encounter.
Comments

SHALL contain exactly one [1..1] componentOf (CONF:1198-8386).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
1176. ClinicalDocument.componentOf.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1178. ClinicalDocument.componentOf.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
1180. ClinicalDocument.componentOf.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
1182. ClinicalDocument.componentOf.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
1184. ClinicalDocument.componentOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipHasComponent
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 ValueCOMP
1186. ClinicalDocument.componentOf.encompassingEncounter
Comments

This componentOf SHALL contain exactly one [1..1] encompassingEncounter (CONF:1198-8387).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
1188. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control0..1
BindingThe codes SHALL be taken from ActClass
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 ValueENC
1190. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
1192. ClinicalDocument.componentOf.encompassingEncounter.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
1194. ClinicalDocument.componentOf.encompassingEncounter.id
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1196. ClinicalDocument.componentOf.encompassingEncounter.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1198. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (DT.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8389).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time (DT.US.FIELDED))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
81-10078: **SHALL** be precise to the day (CONF:81-10078). ()
81-10079: **SHOULD** be precise to the minute (CONF:81-10079). ()
81-10080: **MAY** be precise to the second (CONF:81-10080). ()
81-10081: If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081). ()
1200. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
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 nameadmissionReferralSourceCode.
1202. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from USEncounterDischargeDisposition
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1204. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Definition

The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.

Comments

This encompassingEncounter MAY contain zero or one [0..1] responsibleParty (CONF:1198-8391).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1206. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1208. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
1210. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
1212. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
1214. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control0..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 ValueRESP
1216. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Comments

The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). ()
1218. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
ShortThe encounterParticipant element represents persons who participated in the encounter and not necessarily the entire episode of care.
Comments

This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8392).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
1220. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1222. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.typeCode
Control0..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.
1224. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.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
1226. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.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
1228. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.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
1230. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1232. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant.assignedEntity
Comments

The encounterParticipant, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32902).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants1198-32906: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32906). ()
1234. ClinicalDocument.componentOf.encompassingEncounter.location
Definition

The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1236. ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1238. ClinicalDocument.componentOf.encompassingEncounter.location.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
1240. ClinicalDocument.componentOf.encompassingEncounter.location.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
1242. ClinicalDocument.componentOf.encompassingEncounter.location.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
1244. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationTargetLocation
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 ValueLOC
1246. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
1248. ClinicalDocument.component
Comments

SHALL contain exactly one [1..1] component (CONF:1198-8397).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component
1250. ClinicalDocument.component.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1252. ClinicalDocument.component.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
1254. ClinicalDocument.component.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
1256. ClinicalDocument.component.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
1258. ClinicalDocument.component.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipHasComponent
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 ValueCOMP
1260. ClinicalDocument.component.contextConductionInd
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.
Fixed Valuetrue
1262. ClinicalDocument.component.nonXMLBody
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody
1264. ClinicalDocument.component.structuredBody
Comments

This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-28895).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
Invariants1198-28939: This structuredBody **SHALL NOT** contain an Assessment and Plan Section (2.16.840.1.113883.10.20.22.2.9:2014-06-09) when either an Assessment Section (2.16.840.1.113883.10.20.22.2.8) or a Plan of Treatment Section (2.16.840.1.113883.10.20.22.2.10:2014-06-09) is present (CONF:1198-28939). ()
1198-28940: This structuredBody **SHALL NOT** contain a Chief Complaint and Reason for Visit Section (2.16.840.1.113883.10.20.22.2.13) when either a Chief Complaint Section (1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) or a Reason for Visit Section (2.16.840.1.113883.10.20.22.2.12) is present (CONF:1198-28940). ()
1198-9504: **SHALL** include a Reason for Referral or Reason for Visit section (CONF:1198-9504). ()
1198-9501: **SHALL** include an Assessment and Plan Section, or both an Assessment Section and a Plan of Treatment Section (CONF:1198-9501). ()
1266. ClinicalDocument.component.structuredBody.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1268. ClinicalDocument.component.structuredBody.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
1270. ClinicalDocument.component.structuredBody.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
1272. ClinicalDocument.component.structuredBody.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
1274. ClinicalDocument.component.structuredBody.classCode
Control0..1
BindingThe codes SHALL be taken from ActClassRecordOrganizer
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 ValueDOCBODY
1276. ClinicalDocument.component.structuredBody.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
1278. ClinicalDocument.component.structuredBody.confidentialityCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1280. ClinicalDocument.component.structuredBody.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
1282. ClinicalDocument.component.structuredBody.component
Control5..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ section
1284. ClinicalDocument.component.structuredBody.component.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1286. ClinicalDocument.component.structuredBody.component.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
1288. ClinicalDocument.component.structuredBody.component.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
1290. ClinicalDocument.component.structuredBody.component.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
1292. ClinicalDocument.component.structuredBody.component.typeCode
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.
Fixed ValueCOMP
1294. ClinicalDocument.component.structuredBody.component.contextConductionInd
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.
Fixed Valuetrue
1296. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section
1298. ClinicalDocument.component.structuredBody.component:component1
Slice Namecomponent1
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28896) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1300. ClinicalDocument.component.structuredBody.component:component1.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1302. ClinicalDocument.component.structuredBody.component:component1.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
1304. ClinicalDocument.component.structuredBody.component:component1.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
1306. ClinicalDocument.component.structuredBody.component:component1.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
1308. ClinicalDocument.component.structuredBody.component:component1.typeCode
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.
Fixed ValueCOMP
1310. ClinicalDocument.component.structuredBody.component:component1.contextConductionInd
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.
Fixed Valuetrue
1312. ClinicalDocument.component.structuredBody.component:component1.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

The component, if present, SHALL contain exactly one [1..1] Assessment Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.8) (CONF:1198-28897).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Assessment Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1314. ClinicalDocument.component.structuredBody.component:component2
Slice Namecomponent2
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28898) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1316. ClinicalDocument.component.structuredBody.component:component2.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1318. ClinicalDocument.component.structuredBody.component:component2.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
1320. ClinicalDocument.component.structuredBody.component:component2.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
1322. ClinicalDocument.component.structuredBody.component:component2.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
1324. ClinicalDocument.component.structuredBody.component:component2.typeCode
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.
Fixed ValueCOMP
1326. ClinicalDocument.component.structuredBody.component:component2.contextConductionInd
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.
Fixed Valuetrue
1328. ClinicalDocument.component.structuredBody.component:component2.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Assessment and Plan Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.9:2014-06-09) (CONF:1198-28899).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Assessment and Plan Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1330. ClinicalDocument.component.structuredBody.component:component3
Slice Namecomponent3
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28900) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1332. ClinicalDocument.component.structuredBody.component:component3.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1334. ClinicalDocument.component.structuredBody.component:component3.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
1336. ClinicalDocument.component.structuredBody.component:component3.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
1338. ClinicalDocument.component.structuredBody.component:component3.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
1340. ClinicalDocument.component.structuredBody.component:component3.typeCode
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.
Fixed ValueCOMP
1342. ClinicalDocument.component.structuredBody.component:component3.contextConductionInd
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.
Fixed Valuetrue
1344. ClinicalDocument.component.structuredBody.component:component3.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-28901).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1346. ClinicalDocument.component.structuredBody.component:component4
Slice Namecomponent4
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28904) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1348. ClinicalDocument.component.structuredBody.component:component4.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1350. ClinicalDocument.component.structuredBody.component:component4.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
1352. ClinicalDocument.component.structuredBody.component:component4.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
1354. ClinicalDocument.component.structuredBody.component:component4.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
1356. ClinicalDocument.component.structuredBody.component:component4.typeCode
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.
Fixed ValueCOMP
1358. ClinicalDocument.component.structuredBody.component:component4.contextConductionInd
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.
Fixed Valuetrue
1360. ClinicalDocument.component.structuredBody.component:component4.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.12) (CONF:1198-28905).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Reason for Visit Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1362. ClinicalDocument.component.structuredBody.component:component5
Slice Namecomponent5
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28906) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1364. ClinicalDocument.component.structuredBody.component:component5.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1366. ClinicalDocument.component.structuredBody.component:component5.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
1368. ClinicalDocument.component.structuredBody.component:component5.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
1370. ClinicalDocument.component.structuredBody.component:component5.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
1372. ClinicalDocument.component.structuredBody.component:component5.typeCode
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.
Fixed ValueCOMP
1374. ClinicalDocument.component.structuredBody.component:component5.contextConductionInd
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.
Fixed Valuetrue
1376. ClinicalDocument.component.structuredBody.component:component5.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] History of Present Illness Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.4) (CONF:1198-28907).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(History of Present Illness Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1378. ClinicalDocument.component.structuredBody.component:component6
Slice Namecomponent6
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28908) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1380. ClinicalDocument.component.structuredBody.component:component6.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1382. ClinicalDocument.component.structuredBody.component:component6.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
1384. ClinicalDocument.component.structuredBody.component:component6.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
1386. ClinicalDocument.component.structuredBody.component:component6.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
1388. ClinicalDocument.component.structuredBody.component:component6.typeCode
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.
Fixed ValueCOMP
1390. ClinicalDocument.component.structuredBody.component:component6.contextConductionInd
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.
Fixed Valuetrue
1392. ClinicalDocument.component.structuredBody.component:component6.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Physical Exam Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.2.10:2015-08-01) (CONF:1198-28909).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Physical Exam Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1394. ClinicalDocument.component.structuredBody.component:component7
Slice Namecomponent7
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28910) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1396. ClinicalDocument.component.structuredBody.component:component7.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1398. ClinicalDocument.component.structuredBody.component:component7.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
1400. ClinicalDocument.component.structuredBody.component:component7.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
1402. ClinicalDocument.component.structuredBody.component:component7.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
1404. ClinicalDocument.component.structuredBody.component:component7.typeCode
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.
Fixed ValueCOMP
1406. ClinicalDocument.component.structuredBody.component:component7.contextConductionInd
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.
Fixed Valuetrue
1408. ClinicalDocument.component.structuredBody.component:component7.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Allergies and Intolerances Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.6.1:2015-08-01) (CONF:1198-28911).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Allergies and Intolerances Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1410. ClinicalDocument.component.structuredBody.component:component8
Slice Namecomponent8
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28912) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1412. ClinicalDocument.component.structuredBody.component:component8.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1414. ClinicalDocument.component.structuredBody.component:component8.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
1416. ClinicalDocument.component.structuredBody.component:component8.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
1418. ClinicalDocument.component.structuredBody.component:component8.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
1420. ClinicalDocument.component.structuredBody.component:component8.typeCode
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.
Fixed ValueCOMP
1422. ClinicalDocument.component.structuredBody.component:component8.contextConductionInd
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.
Fixed Valuetrue
1424. ClinicalDocument.component.structuredBody.component:component8.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Chief Complaint Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.1.13.2.1) (CONF:1198-28913).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Chief Complaint Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1426. ClinicalDocument.component.structuredBody.component:component9
Slice Namecomponent9
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28915) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1428. ClinicalDocument.component.structuredBody.component:component9.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1430. ClinicalDocument.component.structuredBody.component:component9.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
1432. ClinicalDocument.component.structuredBody.component:component9.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
1434. ClinicalDocument.component.structuredBody.component:component9.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
1436. ClinicalDocument.component.structuredBody.component:component9.typeCode
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.
Fixed ValueCOMP
1438. ClinicalDocument.component.structuredBody.component:component9.contextConductionInd
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.
Fixed Valuetrue
1440. ClinicalDocument.component.structuredBody.component:component9.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Chief Complaint and Reason for Visit Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.13) (CONF:1198-28916).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Chief Complaint and Reason for Visit Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1442. ClinicalDocument.component.structuredBody.component:component10
Slice Namecomponent10
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28917) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1444. ClinicalDocument.component.structuredBody.component:component10.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1446. ClinicalDocument.component.structuredBody.component:component10.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
1448. ClinicalDocument.component.structuredBody.component:component10.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
1450. ClinicalDocument.component.structuredBody.component:component10.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
1452. ClinicalDocument.component.structuredBody.component:component10.typeCode
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.
Fixed ValueCOMP
1454. ClinicalDocument.component.structuredBody.component:component10.contextConductionInd
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.
Fixed Valuetrue
1456. ClinicalDocument.component.structuredBody.component:component10.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Family History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.15:2015-08-01) (CONF:1198-28918).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Family History Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1458. ClinicalDocument.component.structuredBody.component:component11
Slice Namecomponent11
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28919) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1460. ClinicalDocument.component.structuredBody.component:component11.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1462. ClinicalDocument.component.structuredBody.component:component11.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
1464. ClinicalDocument.component.structuredBody.component:component11.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
1466. ClinicalDocument.component.structuredBody.component:component11.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
1468. ClinicalDocument.component.structuredBody.component:component11.typeCode
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.
Fixed ValueCOMP
1470. ClinicalDocument.component.structuredBody.component:component11.contextConductionInd
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.
Fixed Valuetrue
1472. ClinicalDocument.component.structuredBody.component:component11.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] General Status Section (identifier: urn:oid:2.16.840.1.113883.10.20.2.5) (CONF:1198-28920).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(General Status Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1474. ClinicalDocument.component.structuredBody.component:component12
Slice Namecomponent12
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28921) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1476. ClinicalDocument.component.structuredBody.component:component12.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1478. ClinicalDocument.component.structuredBody.component:component12.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
1480. ClinicalDocument.component.structuredBody.component:component12.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
1482. ClinicalDocument.component.structuredBody.component:component12.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
1484. ClinicalDocument.component.structuredBody.component:component12.typeCode
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.
Fixed ValueCOMP
1486. ClinicalDocument.component.structuredBody.component:component12.contextConductionInd
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.
Fixed Valuetrue
1488. ClinicalDocument.component.structuredBody.component:component12.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Past Medical History (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.20:2015-08-01) (CONF:1198-28922).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Past Medical History)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1490. ClinicalDocument.component.structuredBody.component:component13
Slice Namecomponent13
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28923) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1492. ClinicalDocument.component.structuredBody.component:component13.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1494. ClinicalDocument.component.structuredBody.component:component13.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
1496. ClinicalDocument.component.structuredBody.component:component13.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
1498. ClinicalDocument.component.structuredBody.component:component13.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
1500. ClinicalDocument.component.structuredBody.component:component13.typeCode
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.
Fixed ValueCOMP
1502. ClinicalDocument.component.structuredBody.component:component13.contextConductionInd
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.
Fixed Valuetrue
1504. ClinicalDocument.component.structuredBody.component:component13.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Immunizations Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2015-08-01) (CONF:1198-28924).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Immunizations Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1506. ClinicalDocument.component.structuredBody.component:component14
Slice Namecomponent14
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28925) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1508. ClinicalDocument.component.structuredBody.component:component14.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1510. ClinicalDocument.component.structuredBody.component:component14.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
1512. ClinicalDocument.component.structuredBody.component:component14.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
1514. ClinicalDocument.component.structuredBody.component:component14.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
1516. ClinicalDocument.component.structuredBody.component:component14.typeCode
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.
Fixed ValueCOMP
1518. ClinicalDocument.component.structuredBody.component:component14.contextConductionInd
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.
Fixed Valuetrue
1520. ClinicalDocument.component.structuredBody.component:component14.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Medications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.1.1:2014-06-09) (CONF:1198-28926).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Medications Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1522. ClinicalDocument.component.structuredBody.component:component15
Slice Namecomponent15
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-28928) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1524. ClinicalDocument.component.structuredBody.component:component15.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1526. ClinicalDocument.component.structuredBody.component:component15.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
1528. ClinicalDocument.component.structuredBody.component:component15.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
1530. ClinicalDocument.component.structuredBody.component:component15.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
1532. ClinicalDocument.component.structuredBody.component:component15.typeCode
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.
Fixed ValueCOMP
1534. ClinicalDocument.component.structuredBody.component:component15.contextConductionInd
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.
Fixed Valuetrue
1536. ClinicalDocument.component.structuredBody.component:component15.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Problem Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.5.1:2015-08-01) (CONF:1198-28929).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Problem Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1538. ClinicalDocument.component.structuredBody.component:component16
Slice Namecomponent16
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28930) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1540. ClinicalDocument.component.structuredBody.component:component16.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1542. ClinicalDocument.component.structuredBody.component:component16.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
1544. ClinicalDocument.component.structuredBody.component:component16.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
1546. ClinicalDocument.component.structuredBody.component:component16.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
1548. ClinicalDocument.component.structuredBody.component:component16.typeCode
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.
Fixed ValueCOMP
1550. ClinicalDocument.component.structuredBody.component:component16.contextConductionInd
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.
Fixed Valuetrue
1552. ClinicalDocument.component.structuredBody.component:component16.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Procedures Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.7.1:2014-06-09) (CONF:1198-28931).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedures Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1554. ClinicalDocument.component.structuredBody.component:component17
Slice Namecomponent17
Comments

This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-28932) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1556. ClinicalDocument.component.structuredBody.component:component17.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1558. ClinicalDocument.component.structuredBody.component:component17.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
1560. ClinicalDocument.component.structuredBody.component:component17.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
1562. ClinicalDocument.component.structuredBody.component:component17.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
1564. ClinicalDocument.component.structuredBody.component:component17.typeCode
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.
Fixed ValueCOMP
1566. ClinicalDocument.component.structuredBody.component:component17.contextConductionInd
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.
Fixed Valuetrue
1568. ClinicalDocument.component.structuredBody.component:component17.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Results Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.3.1:2015-08-01) (CONF:1198-28933).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Results Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1570. ClinicalDocument.component.structuredBody.component:component18
Slice Namecomponent18
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28934) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1572. ClinicalDocument.component.structuredBody.component:component18.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1574. ClinicalDocument.component.structuredBody.component:component18.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
1576. ClinicalDocument.component.structuredBody.component:component18.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
1578. ClinicalDocument.component.structuredBody.component:component18.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
1580. ClinicalDocument.component.structuredBody.component:component18.typeCode
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.
Fixed ValueCOMP
1582. ClinicalDocument.component.structuredBody.component:component18.contextConductionInd
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.
Fixed Valuetrue
1584. ClinicalDocument.component.structuredBody.component:component18.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Social History Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.17:2015-08-01) (CONF:1198-28935).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Social History Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1586. ClinicalDocument.component.structuredBody.component:component19
Slice Namecomponent19
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28936) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1588. ClinicalDocument.component.structuredBody.component:component19.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1590. ClinicalDocument.component.structuredBody.component:component19.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
1592. ClinicalDocument.component.structuredBody.component:component19.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
1594. ClinicalDocument.component.structuredBody.component:component19.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
1596. ClinicalDocument.component.structuredBody.component:component19.typeCode
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.
Fixed ValueCOMP
1598. ClinicalDocument.component.structuredBody.component:component19.contextConductionInd
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.
Fixed Valuetrue
1600. ClinicalDocument.component.structuredBody.component:component19.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Vital Signs Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.4.1:2015-08-01) (CONF:1198-28937).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Vital Signs Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1602. ClinicalDocument.component.structuredBody.component:component25
Slice Namecomponent25
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1604. ClinicalDocument.component.structuredBody.component:component25.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1606. ClinicalDocument.component.structuredBody.component:component25.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
1608. ClinicalDocument.component.structuredBody.component:component25.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
1610. ClinicalDocument.component.structuredBody.component:component25.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
1612. ClinicalDocument.component.structuredBody.component:component25.typeCode
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.
Fixed ValueCOMP
1614. ClinicalDocument.component.structuredBody.component:component25.contextConductionInd
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.
Fixed Valuetrue
1616. ClinicalDocument.component.structuredBody.component:component25.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2015-08-01) (CONF:1198-28943).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1618. ClinicalDocument.component.structuredBody.component:component20
Slice Namecomponent20
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28944) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1620. ClinicalDocument.component.structuredBody.component:component20.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1622. ClinicalDocument.component.structuredBody.component:component20.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
1624. ClinicalDocument.component.structuredBody.component:component20.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
1626. ClinicalDocument.component.structuredBody.component:component20.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
1628. ClinicalDocument.component.structuredBody.component:component20.typeCode
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.
Fixed ValueCOMP
1630. ClinicalDocument.component.structuredBody.component:component20.contextConductionInd
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.
Fixed Valuetrue
1632. ClinicalDocument.component.structuredBody.component:component20.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Functional Status Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.14:2014-06-09) (CONF:1198-28945).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Functional Status Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1634. ClinicalDocument.component.structuredBody.component:component21
Slice Namecomponent21
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30237) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1636. ClinicalDocument.component.structuredBody.component:component21.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1638. ClinicalDocument.component.structuredBody.component:component21.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
1640. ClinicalDocument.component.structuredBody.component:component21.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
1642. ClinicalDocument.component.structuredBody.component:component21.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
1644. ClinicalDocument.component.structuredBody.component:component21.typeCode
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.
Fixed ValueCOMP
1646. ClinicalDocument.component.structuredBody.component:component21.contextConductionInd
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.
Fixed Valuetrue
1648. ClinicalDocument.component.structuredBody.component:component21.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Review of Systems Section (identifier: urn:oid:1.3.6.1.4.1.19376.1.5.3.1.3.18) (CONF:1198-30238).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Review of Systems Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1650. ClinicalDocument.component.structuredBody.component:component22
Slice Namecomponent22
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30904) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1652. ClinicalDocument.component.structuredBody.component:component22.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1654. ClinicalDocument.component.structuredBody.component:component22.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
1656. ClinicalDocument.component.structuredBody.component:component22.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
1658. ClinicalDocument.component.structuredBody.component:component22.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
1660. ClinicalDocument.component.structuredBody.component:component22.typeCode
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.
Fixed ValueCOMP
1662. ClinicalDocument.component.structuredBody.component:component22.contextConductionInd
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.
Fixed Valuetrue
1664. ClinicalDocument.component.structuredBody.component:component22.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Medical Equipment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.23:2014-06-09) (CONF:1198-30905).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Medical Equipment Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1666. ClinicalDocument.component.structuredBody.component:component23
Slice Namecomponent23
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30906) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1668. ClinicalDocument.component.structuredBody.component:component23.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1670. ClinicalDocument.component.structuredBody.component:component23.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
1672. ClinicalDocument.component.structuredBody.component:component23.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
1674. ClinicalDocument.component.structuredBody.component:component23.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
1676. ClinicalDocument.component.structuredBody.component:component23.typeCode
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.
Fixed ValueCOMP
1678. ClinicalDocument.component.structuredBody.component:component23.contextConductionInd
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.
Fixed Valuetrue
1680. ClinicalDocument.component.structuredBody.component:component23.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Mental Status Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.56:2015-08-01) (CONF:1198-30907).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Mental Status Section)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1682. ClinicalDocument.component.structuredBody.component:component24
Slice Namecomponent24
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30909) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1684. ClinicalDocument.component.structuredBody.component:component24.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
1686. ClinicalDocument.component.structuredBody.component:component24.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
1688. ClinicalDocument.component.structuredBody.component:component24.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
1690. ClinicalDocument.component.structuredBody.component:component24.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
1692. ClinicalDocument.component.structuredBody.component:component24.typeCode
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.
Fixed ValueCOMP
1694. ClinicalDocument.component.structuredBody.component:component24.contextConductionInd
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.
Fixed Valuetrue
1696. ClinicalDocument.component.structuredBody.component:component24.section
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Nutrition Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.57) (CONF:1198-30910).

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