Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

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

Active as of 2023-09-29

Definitions for the ContinuityofCareDocumentCCD logical model.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

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

0. ClinicalDocument
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. ClinicalDocument.templateId
Control | 2..?
4. ClinicalDocument.templateId:primary
Slice Name | primary
Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-8450) such that it
Control | 1..1
6. ClinicalDocument.templateId:primary.root
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.2" (CONF:1198-10038).
Control | 1..?
Pattern Value | 2.16.840.1.113883.10.20.22.1.2
8. ClinicalDocument.templateId:primary.extension
Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32516).
Control | 1..?
Pattern Value | 2015-08-01
10. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:1198-17180).
12. ClinicalDocument.code.code
Comments | This code SHALL contain exactly one [1..1] @code="34133-9" Summarization of Episode Note (CONF:1198-17181).
Control | 1..?
Pattern Value | 34133-9
14. ClinicalDocument.code.codeSystem
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32138).
Control | 1..?
Pattern Value | 2.16.840.1.113883.6.1
16. ClinicalDocument.author
Comments | SHALL contain at least one [1..*] author (CONF:1198-9442).
18. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-9443).
Invariants | 1198-8456: Such assignedAuthors **SHALL** contain (exactly one [1..1] assignedPerson) or (exactly one [1..1] assignedAuthoringDevice and exactly one [1..1] representedOrganization) (CONF:1198-8456). () 1198-8457: If assignedAuthor has an associated representedOrganization with no assignedPerson or assignedAuthoringDevice, then the value for “ClinicalDocument/author/assignedAuthor/id/@NullFlavor” **SHALL** be “NA” “Not applicable” 2.16.840.1.113883.5.1008 NullFlavor STATIC (CONF:1198-8457). ()
20. ClinicalDocument.documentationOf
Short | The documentationOf relationship in a Continuity Care Document contains the representation of providers who are wholly or partially responsible for the safety and well-being of a subject of care.
Comments | SHALL contain exactly one [1..1] documentationOf (CONF:1198-8452).
Control | 1..1
22. ClinicalDocument.documentationOf.serviceEvent
Short | The main activity being described by a CCD is the provision of healthcare over a period of time. This is shown by setting the value of serviceEvent/@classCode to 'PCPR' (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). NOTE: Implementations originating a CCD should take care to discover what the episode of care being summarized is. For example, when a patient fills out a form providing relevant health history, the episode of care being documented might be from birth to the present.
Comments | This documentationOf SHALL contain exactly one [1..1] serviceEvent (CONF:1198-8480).
24. ClinicalDocument.documentationOf.serviceEvent.classCode
Comments | This serviceEvent SHALL contain exactly one [1..1] @classCode="PCPR" Care Provision (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8453).
Fixed Value | PCPR
26. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8481).
28. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:1198-8454).
30. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Comments | This effectiveTime SHALL contain exactly one [1..1] high (CONF:1198-8455).
Control | 1..?
32. ClinicalDocument.documentationOf.serviceEvent.performer
Short | The serviceEvent/performer represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare providers would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-8482).
34. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode="PRF" Participation physical performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8458).
Fixed Value | PRF
36. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Short | SG 20230709: Illegal constraint - base has min = 1 (deleted min=0)
Comments | The performer, if present, MAY contain zero or one [0..1] assignedEntity (CONF:1198-8459).
38. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | The assignedEntity, if present, SHALL contain at least one [1..*] id (CONF:1198-30882).
Invariants | 1198-32466: If this assignedEntity is an assignedPerson, the assignedEntity/id **SHOULD** contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32466). ()
40. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Comments | The assignedEntity, if present, MAY contain zero or one [0..1] assignedPerson (CONF:1198-32467).
42. ClinicalDocument.component
Comments | SHALL contain exactly one [1..1] component (CONF:1198-30659).
44. ClinicalDocument.component.structuredBody
Comments | This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30660).
Control | 1..?
46. ClinicalDocument.component.structuredBody.component
Control | 6..?
Slicing | This 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
48. ClinicalDocument.component.structuredBody.component:allergies
Slice Name | allergies
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30661).
Control | 1..1
50. ClinicalDocument.component.structuredBody.component:allergies.section
Comments | This component 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-30662).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Allergies and Intolerances Section)
52. ClinicalDocument.component.structuredBody.component:medications
Slice Name | medications
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30663) such that it
Control | 1..1
54. ClinicalDocument.component.structuredBody.component:medications.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-30664).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Medications Section)
56. ClinicalDocument.component.structuredBody.component:problems
Slice Name | problems
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30665) such that it
Control | 1..1
58. ClinicalDocument.component.structuredBody.component:problems.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-30666).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Problem Section)
60. ClinicalDocument.component.structuredBody.component:procedures
Slice Name | procedures
Comments | This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30667) such that it
Control | 0..1
62. ClinicalDocument.component.structuredBody.component:procedures.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-30668).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Procedures Section)
64. ClinicalDocument.component.structuredBody.component:results
Slice Name | results
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30669) such that it
Control | 1..1
66. ClinicalDocument.component.structuredBody.component:results.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-30670).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Results Section)
68. ClinicalDocument.component.structuredBody.component:advDirectives
Slice Name | advDirectives
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30671) such that it
Control | 0..1
70. ClinicalDocument.component.structuredBody.component:advDirectives.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-30672).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
72. ClinicalDocument.component.structuredBody.component:encounters
Slice Name | encounters
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30673) such that it
Control | 0..1
74. ClinicalDocument.component.structuredBody.component:encounters.section
Comments | SHALL contain exactly one [1..1] Encounters Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.22.1:2015-08-01) (CONF:1198-30674).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Encounters Section)
76. ClinicalDocument.component.structuredBody.component:famHistory
Slice Name | famHistory
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30675) such that it
Control | 0..1
78. ClinicalDocument.component.structuredBody.component:famHistory.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-30676).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Family History Section)
80. ClinicalDocument.component.structuredBody.component:functionalStatus
Slice Name | functionalStatus
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30677) such that it
Control | 0..1
82. ClinicalDocument.component.structuredBody.component:functionalStatus.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-30678).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Functional Status Section)
84. ClinicalDocument.component.structuredBody.component:immunizations
Slice Name | immunizations
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30679) such that it
Control | 0..1
86. ClinicalDocument.component.structuredBody.component:immunizations.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-30680).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Immunizations Section)
88. ClinicalDocument.component.structuredBody.component:medEquipment
Slice Name | medEquipment
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30681) such that it
Control | 0..1
90. ClinicalDocument.component.structuredBody.component:medEquipment.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-30682).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Medical Equipment Section)
92. ClinicalDocument.component.structuredBody.component:payers
Slice Name | payers
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30683) such that it
Control | 0..1
94. ClinicalDocument.component.structuredBody.component:payers.section
Comments | SHALL contain exactly one [1..1] Payers Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.18:2015-08-01) (CONF:1198-30684).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Payers Section)
96. ClinicalDocument.component.structuredBody.component:planOfTreatment
Slice Name | planOfTreatment
Comments | This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30685) such that it
Control | 0..1
98. ClinicalDocument.component.structuredBody.component:planOfTreatment.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-30686).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
100. ClinicalDocument.component.structuredBody.component:socialHist
Slice Name | socialHist
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30687) such that it
Control | 1..1
102. ClinicalDocument.component.structuredBody.component:socialHist.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-30688).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Social History Section)
104. ClinicalDocument.component.structuredBody.component:vitalSigns
Slice Name | vitalSigns
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30689) such that it
Control | 1..1
106. ClinicalDocument.component.structuredBody.component:vitalSigns.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-30690).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Vital Signs Section)
108. ClinicalDocument.component.structuredBody.component:mentalStatus
Slice Name | mentalStatus
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32143) such that it
Control | 0..1
110. ClinicalDocument.component.structuredBody.component:mentalStatus.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-32144).
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Mental Status Section)
112. ClinicalDocument.component.structuredBody.component:nutrition
Slice Name | nutrition
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32624) such that it
Control | 0..1
114. ClinicalDocument.component.structuredBody.component:nutrition.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-32625).
Type | http://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.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-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).
Control | 1..1
Type | http://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.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | US
6. ClinicalDocument.realmCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
8. ClinicalDocument.realmCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
10. ClinicalDocument.realmCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code 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.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
14. ClinicalDocument.realmCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
16. ClinicalDocument.realmCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
18. ClinicalDocument.realmCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
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).
Control | 1..1
Type | http://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).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | 2.16.840.1.113883.1.3
24. ClinicalDocument.typeId.extension
Definition | An Extension
Short | Extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POCD_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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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 Name | us-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-5252) such that it
Control | 1..1
Type | http://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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.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).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-05-01
34. ClinicalDocument.templateId:primary
Slice Name | primary
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-8450) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
36. ClinicalDocument.templateId:primary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.2" (CONF:1198-10038).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.22.1.2
38. ClinicalDocument.templateId:primary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32516).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2015-08-01
40. ClinicalDocument.id
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
42. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:1198-17180).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | 4537-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.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | This code SHALL contain exactly one [1..1] @code="34133-9" Summarization of Episode Note (CONF:1198-17181).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | 34133-9
46. ClinicalDocument.code.codeSystem
Definition | Specifies the code system that defines the code.
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32138).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
Pattern Value | 2.16.840.1.113883.6.1
48. ClinicalDocument.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
50. ClinicalDocument.title
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
52. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
54. 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).
Control | 1..1
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
56. 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).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
58. ClinicalDocument.recordTarget
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
60. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
62. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
64. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
66. ClinicalDocument.recordTarget.patientRole.telecom
Comments | This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
68. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
70. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
72. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Patient Name (PTN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
Invariants | ele-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). ()
74. 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).
Control | 1..1
Binding | The codes SHALL be taken from Administrative Gender (HL7 V3)
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
76. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants | 4537-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). ()
78. 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).
Control | 1..1
Binding | The codes SHALL be taken from Race Category Excluding Nulls
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
80. 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).
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
82. ClinicalDocument.author
Comments | SHALL contain at least one [1..*] author (CONF:1198-9442).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
84. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
86. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-9443).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). () 1198-8456: Such assignedAuthors **SHALL** contain (exactly one [1..1] assignedPerson) or (exactly one [1..1] assignedAuthoringDevice and exactly one [1..1] representedOrganization) (CONF:1198-8456). () 1198-8457: If assignedAuthor has an associated representedOrganization with no assignedPerson or assignedAuthoringDevice, then the value for “ClinicalDocument/author/assignedAuthor/id/@NullFlavor” **SHALL** be “NA” “Not applicable” 2.16.840.1.113883.5.1008 NullFlavor STATIC (CONF:1198-8457). ()
88. 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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
90. ClinicalDocument.author.assignedAuthor.id:id1
Slice Name | id1
Short | id
Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
92. 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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
94. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
96. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
98. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
100. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This 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
102. ClinicalDocument.informant:informant1
Slice Name | informant1
Short | informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
104. ClinicalDocument.informant:informant1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
106. ClinicalDocument.informant:informant1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-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). ()
108. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
110. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
112. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-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). ()
114. ClinicalDocument.informant:informant2
Slice Name | informant2
Short | informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
116. ClinicalDocument.informant:informant2.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
118. ClinicalDocument.custodian
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
120. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
122. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
124. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
126. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
128. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
130. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
132. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
134. ClinicalDocument.authenticator
Comments | MAY contain zero or more [0..*] authenticator (CONF:4537-5607) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
Slicing | This 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
136. ClinicalDocument.authenticator:authenticator1
Slice Name | authenticator1
Short | authenticator
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
138. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
140. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
142. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
144. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
146. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
148. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
150. 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.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
152. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
154. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
156. ClinicalDocument.authenticator:authenticator1.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
158. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
160. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
162. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
164. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
166. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
168. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
170. 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.
Short | Base 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.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ele-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). ()
172. ClinicalDocument.documentationOf
Short | The documentationOf relationship in a Continuity Care Document contains the representation of providers who are wholly or partially responsible for the safety and well-being of a subject of care.
Comments | SHALL contain exactly one [1..1] documentationOf (CONF:1198-8452).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
174. ClinicalDocument.documentationOf.serviceEvent
Short | The main activity being described by a CCD is the provision of healthcare over a period of time. This is shown by setting the value of serviceEvent/@classCode to 'PCPR' (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). NOTE: Implementations originating a CCD should take care to discover what the episode of care being summarized is. For example, when a patient fills out a form providing relevant health history, the episode of care being documented might be from birth to the present.
Comments | This documentationOf SHALL contain exactly one [1..1] serviceEvent (CONF:1198-8480).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
176. ClinicalDocument.documentationOf.serviceEvent.classCode
Comments | This serviceEvent SHALL contain exactly one [1..1] @classCode="PCPR" Care Provision (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8453).
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
Fixed Value | PCPR
178. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8481).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
180. 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:1198-8454).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
182. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] high (CONF:1198-8455).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
184. ClinicalDocument.documentationOf.serviceEvent.performer
Short | The serviceEvent/performer represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare providers would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-8482).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
186. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode="PRF" Participation physical performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8458).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PRF
188. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Short | SG 20230709: Illegal constraint - base has min = 1 (deleted min=0)
Comments | The performer, if present, MAY contain zero or one [0..1] assignedEntity (CONF:1198-8459).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
190. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | The assignedEntity, if present, SHALL contain at least one [1..*] id (CONF:1198-30882).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 1198-32466: If this assignedEntity is an assignedPerson, the assignedEntity/id **SHOULD** contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32466). ()
192. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Comments | The assignedEntity, if present, MAY contain zero or one [0..1] assignedPerson (CONF:1198-32467).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
194. ClinicalDocument.component
Comments | SHALL contain exactly one [1..1] component (CONF:1198-30659).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component
196. ClinicalDocument.component.structuredBody
Comments | This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30660).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
198. ClinicalDocument.component.structuredBody.component
Control | 6..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This 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
200. ClinicalDocument.component.structuredBody.component.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
202. ClinicalDocument.component.structuredBody.component:allergies
Slice Name | allergies
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30661).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. ClinicalDocument.component.structuredBody.component:allergies.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Comments | This component 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-30662).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Allergies and Intolerances Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
206. ClinicalDocument.component.structuredBody.component:medications
Slice Name | medications
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30663) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
208. ClinicalDocument.component.structuredBody.component:medications.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30664).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Medications Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
210. ClinicalDocument.component.structuredBody.component:problems
Slice Name | problems
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30665) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
212. ClinicalDocument.component.structuredBody.component:problems.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30666).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Problem Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
214. ClinicalDocument.component.structuredBody.component:procedures
Slice Name | procedures
Comments | This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30667) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
216. ClinicalDocument.component.structuredBody.component:procedures.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30668).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Procedures Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
218. ClinicalDocument.component.structuredBody.component:results
Slice Name | results
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30669) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
220. ClinicalDocument.component.structuredBody.component:results.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30670).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Results Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
222. ClinicalDocument.component.structuredBody.component:advDirectives
Slice Name | advDirectives
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30671) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
224. ClinicalDocument.component.structuredBody.component:advDirectives.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30672).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
226. ClinicalDocument.component.structuredBody.component:encounters
Slice Name | encounters
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30673) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
228. ClinicalDocument.component.structuredBody.component:encounters.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] Encounters Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.22.1:2015-08-01) (CONF:1198-30674).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Encounters Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. ClinicalDocument.component.structuredBody.component:famHistory
Slice Name | famHistory
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30675) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. ClinicalDocument.component.structuredBody.component:famHistory.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30676).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Family History Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
234. ClinicalDocument.component.structuredBody.component:functionalStatus
Slice Name | functionalStatus
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30677) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
236. ClinicalDocument.component.structuredBody.component:functionalStatus.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30678).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Functional Status Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
238. ClinicalDocument.component.structuredBody.component:immunizations
Slice Name | immunizations
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30679) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
240. ClinicalDocument.component.structuredBody.component:immunizations.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30680).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Immunizations Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
242. ClinicalDocument.component.structuredBody.component:medEquipment
Slice Name | medEquipment
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30681) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
244. ClinicalDocument.component.structuredBody.component:medEquipment.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30682).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Medical Equipment Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
246. ClinicalDocument.component.structuredBody.component:payers
Slice Name | payers
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30683) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. ClinicalDocument.component.structuredBody.component:payers.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] Payers Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.18:2015-08-01) (CONF:1198-30684).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Payers Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
250. ClinicalDocument.component.structuredBody.component:planOfTreatment
Slice Name | planOfTreatment
Comments | This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30685) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
252. ClinicalDocument.component.structuredBody.component:planOfTreatment.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30686).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
254. ClinicalDocument.component.structuredBody.component:socialHist
Slice Name | socialHist
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30687) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
256. ClinicalDocument.component.structuredBody.component:socialHist.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30688).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Social History Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
258. ClinicalDocument.component.structuredBody.component:vitalSigns
Slice Name | vitalSigns
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30689) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
260. ClinicalDocument.component.structuredBody.component:vitalSigns.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30690).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Vital Signs Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
262. ClinicalDocument.component.structuredBody.component:mentalStatus
Slice Name | mentalStatus
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32143) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
264. ClinicalDocument.component.structuredBody.component:mentalStatus.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-32144).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Mental Status Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
266. ClinicalDocument.component.structuredBody.component:nutrition
Slice Name | nutrition
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32624) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
268. ClinicalDocument.component.structuredBody.component:nutrition.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-32625).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Nutrition Section)
Is Modifier | false
Invariants | ele-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.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. ClinicalDocument.classCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DOCCLIN
4. ClinicalDocument.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
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).
Control | 1..1
Type | http://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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional 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.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | US
12. ClinicalDocument.realmCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
14. ClinicalDocument.realmCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
16. ClinicalDocument.realmCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code 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.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
24. ClinicalDocument.realmCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
26. ClinicalDocument.realmCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
28. ClinicalDocument.realmCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
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).
Control | 1..1
Type | http://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).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | 2.16.840.1.113883.1.3
34. ClinicalDocument.typeId.extension
Definition | An Extension
Short | Extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POCD_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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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 Name | us-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-5252) such that it
Control | 1..1
Type | http://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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.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).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-05-01
50. ClinicalDocument.templateId:primary
Slice Name | primary
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-8450) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
52. ClinicalDocument.templateId:primary.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
54. ClinicalDocument.templateId:primary.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
56. ClinicalDocument.templateId:primary.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
58. ClinicalDocument.templateId:primary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.2" (CONF:1198-10038).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.22.1.2
60. ClinicalDocument.templateId:primary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32516).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2015-08-01
62. ClinicalDocument.id
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-9991: This id **SHALL** be a globally unique identifier for the document (CONF:4537-9991). ()
64. ClinicalDocument.code
Comments | SHALL contain exactly one [1..1] code (CONF:1198-17180).
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | 4537-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.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
68. ClinicalDocument.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | This code SHALL contain exactly one [1..1] @code="34133-9" Summarization of Episode Note (CONF:1198-17181).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | 34133-9
70. ClinicalDocument.code.codeSystem
Definition | Specifies the code system that defines the code.
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32138).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
Pattern Value | 2.16.840.1.113883.6.1
72. ClinicalDocument.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
74. ClinicalDocument.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
76. ClinicalDocument.code.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
78. ClinicalDocument.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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
80. ClinicalDocument.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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
82. ClinicalDocument.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
84. ClinicalDocument.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
86. ClinicalDocument.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
88. ClinicalDocument.title
Short | The 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
90. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
92. 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).
Control | 1..1
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
94. 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).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
96. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). ()
98. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
Invariants | 4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ()
100. ClinicalDocument.copyTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
102. ClinicalDocument.recordTarget
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
104. ClinicalDocument.recordTarget.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
106. ClinicalDocument.recordTarget.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RCT
108. ClinicalDocument.recordTarget.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
110. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
112. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
114. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
116. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
118. ClinicalDocument.recordTarget.patientRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassRelationshipFormal
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PAT
120. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
122. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
124. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
126. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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.recordTarget.patientRole.telecom
Comments | This patientRole SHALL contain at least one [1..*] telecom (CONF:4537-5280).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
130. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
132. ClinicalDocument.recordTarget.patientRole.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
134. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
136. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
138. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
140. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
142. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
144. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
146. ClinicalDocument.recordTarget.patientRole.patient.id
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
148. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
150. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`desc`.
152. 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).
Control | 1..1
Binding | The codes SHALL be taken from Administrative Gender (HL7 V3)
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
154. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Invariants | 4537-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). ()
156. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Short | sdtc:deceasedInd
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedInd`.
Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present (CONF:4537-32993). ()
158. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | sdtc:deceasedTime
Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`deceasedTime`.
160. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
162. 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).
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
Invariants | 4537-32991: **SHALL** be precise to to the year (CONF:4537-32991). () 4537-32992: **SHOULD** be precise to the day (CONF:4537-32992). ()
164. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`multipleBirthInd`.
166. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`multipleBirthOrderNumber`.
168. 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).
Control | 0..1
Binding | The codes SHALL be taken from Marital Status
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
170. 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).
Control | 0..1
Binding | The codes SHALL be taken from Religious Affiliation
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
172. 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).
Control | 1..1
Binding | The codes SHALL be taken from Race Category Excluding Nulls
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
174. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short | The 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).
Control | 0..*
Binding | The codes SHALL be taken from Race Value Set
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`raceCode`.
Invariants | 4537-31347: If sdtc:raceCode is present, then the patient **SHALL** contain [1..1] raceCode (CONF:4537-31347). ()
176. 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).
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
178. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short | ethnicGroupCode
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).
Control | 0..*
Binding | The codes SHALL be taken from Detailed Ethnicity
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`ethnicGroupCode`.
180. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
182. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAgent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | GUARD
184. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
186. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
188. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
190. 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).
Control | 0..1
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
192. 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.
Short | Base 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
194. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
196. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
198. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
200. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
202. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
204. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
206. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
208. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
210. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
212. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
214. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
216. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
218. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments | This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
220. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassPassive
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BIRTHPL
222. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
224. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Place
226. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PLC
228. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
230. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
232. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
234. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | 4537-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). ()
236. 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.
Short | Primitive Type code
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Label | Exceptional Value Detail
Invariants | ele-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]+$')`)
238. 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.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Is Not Ordered
240. 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.
Control | 0..*
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
242. 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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
244. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.delimiter.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DEL
246. 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
248. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.country.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CNT
250. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state
Definition | A sub-unit of a country with limited sovereignty in a federally organized country.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
252. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.state.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STA
254. 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".)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
256. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.county.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CPA
258. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city
Definition | The name of the city, town, village, or other community or delivery center
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
260. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.city.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CTY
262. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
264. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postalCode.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ZIP
266. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine
Definition | Street address line
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
268. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetAddressLine.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | SAL
270. 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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
272. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumber.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNR
274. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric
Definition | The numeric portion of a building number
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
276. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.houseNumberNumeric.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNN
278. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction
Definition | Direction (e.g., N, S, W, E)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
280. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.direction.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DIR
282. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
284. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetName.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STR
286. 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)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
288. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameBase.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STB
290. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
292. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.streetNameType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | STTYP
294. 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
296. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.additionalLocator.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ADL
298. 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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
300. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitID.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | UNID
302. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
304. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.unitType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | UNIT
306. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
308. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.careOf.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CAR
310. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract
Definition | A geographic sub-unit delineated for demographic purposes.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
312. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.censusTract.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CEN
314. 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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
316. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryAddressLine.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DAL
318. 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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
320. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationType.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINST
322. 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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
324. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationArea.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINSTA
326. 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'.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
328. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryInstallationQualifier.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DINSTQ
330. 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.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
332. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryMode.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DMOD
334. 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
336. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.deliveryModeIdentifier.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DMODID
338. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
340. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.buildingNumberSuffix.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | BNS
342. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox
Definition | A numbered box located in a post station.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
344. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.postBox.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | POB
346. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct
Definition | A subsection of a municipality
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
348. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.precinct.partType
Definition | Specifies the type of the address part
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PRE
350. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.other
Definition | Textual representation of (part of) the address
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as unadorned text.
352. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
354. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication (CONF:4537-5406).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
356. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
358. 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).
Control | 1..1
Binding | The codes SHALL be taken from VSAC 2.16.840.1.113883.1.11.11526
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
360. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityMode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
362. 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).
Control | 0..1
Binding | The codes SHALL be taken from LanguageAbilityProficiency
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
364. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
366. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
368. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
370. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
372. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
374. ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
376. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
378. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
380. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
382. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
384. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
386. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
388. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
390. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
392. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
394. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
396. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
398. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
400. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
402. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
404. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
406. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
408. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
410. ClinicalDocument.author
Comments | SHALL contain at least one [1..*] author (CONF:1198-9442).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
412. ClinicalDocument.author.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
414. ClinicalDocument.author.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUT
416. ClinicalDocument.author.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
418. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
420. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
422. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
424. ClinicalDocument.author.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
426. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
428. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-9443).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). () 1198-8456: Such assignedAuthors **SHALL** contain (exactly one [1..1] assignedPerson) or (exactly one [1..1] assignedAuthoringDevice and exactly one [1..1] representedOrganization) (CONF:1198-8456). () 1198-8457: If assignedAuthor has an associated representedOrganization with no assignedPerson or assignedAuthoringDevice, then the value for “ClinicalDocument/author/assignedAuthor/id/@NullFlavor” **SHALL** be “NA” “Not applicable” 2.16.840.1.113883.5.1008 NullFlavor STATIC (CONF:1198-8457). ()
430. ClinicalDocument.author.assignedAuthor.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
432. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
434. 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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
436. ClinicalDocument.author.assignedAuthor.id:id1
Slice Name | id1
Short | id
Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
438. 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).
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
Fixed Value | UNK
440. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
442. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
444. 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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
446. 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).
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
448. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
450. ClinicalDocument.author.assignedAuthor.code
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
452. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
454. 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).
Control | 1..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
456. ClinicalDocument.author.assignedAuthor.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
458. ClinicalDocument.author.assignedAuthor.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
460. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
462. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
464. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
466. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
468. ClinicalDocument.author.assignedAuthor.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
470. ClinicalDocument.author.assignedAuthor.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
472. ClinicalDocument.author.assignedAuthor.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
474. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
476. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
478. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
480. ClinicalDocument.author.assignedAuthor.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
482. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
484. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
486. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4537-5430).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
488. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
490. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
492. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
494. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
496. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
498. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | This assignedAuthor SHOULD contain zero or one [0..1] assignedAuthoringDevice (CONF:4537-16783).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
500. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassDevice
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DEV
502. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
504. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
506. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from EntityCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
508. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..1
Binding | For example codes, see Manufacturer Model Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
510. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..1
Binding | For example codes, see Software Name Example
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
512. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
514. ClinicalDocument.author.assignedAuthor.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
516. ClinicalDocument.dataEnterer
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
518. ClinicalDocument.dataEnterer.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
520. ClinicalDocument.dataEnterer.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENT
522. ClinicalDocument.dataEnterer.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
524. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
526. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
528. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
530. ClinicalDocument.dataEnterer.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
532. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
534. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
536. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
538. ClinicalDocument.dataEnterer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
540. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
542. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
544. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
546. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
548. ClinicalDocument.dataEnterer.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
550. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
552. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
554. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
556. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
558. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
560. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
562. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
564. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
566. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
568. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
570. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
572. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
574. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
576. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
578. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
580. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This 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
582. ClinicalDocument.informant:informant1
Slice Name | informant1
Short | informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
584. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
586. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
588. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
590. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
592. ClinicalDocument.informant:informant1.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INF
594. ClinicalDocument.informant:informant1.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
596. ClinicalDocument.informant:informant1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
598. ClinicalDocument.informant:informant1.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
600. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
602. ClinicalDocument.informant:informant1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 4537-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). ()
604. ClinicalDocument.informant:informant1.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
606. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
608. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
610. ClinicalDocument.informant:informant1.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
612. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
614. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
616. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
618. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
620. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
622. ClinicalDocument.informant:informant1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
624. ClinicalDocument.informant:informant1.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
626. ClinicalDocument.informant:informant1.relatedEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
628. ClinicalDocument.informant:informant2
Slice Name | informant2
Short | informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
630. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
632. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
634. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
636. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
638. ClinicalDocument.informant:informant2.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INF
640. ClinicalDocument.informant:informant2.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
642. ClinicalDocument.informant:informant2.assignedEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
644. ClinicalDocument.informant:informant2.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
646. ClinicalDocument.custodian
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
648. ClinicalDocument.custodian.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
650. ClinicalDocument.custodian.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENT
652. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
654. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
656. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
658. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
660. ClinicalDocument.custodian.assignedCustodian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
662. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
664. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
666. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
668. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
670. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
672. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
674. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
676. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
678. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
680. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
682. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
684. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
686. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
688. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
690. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
692. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
694. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
696. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
698. ClinicalDocument.informationRecipient
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
700. ClinicalDocument.informationRecipient.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
702. ClinicalDocument.informationRecipient.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | PRCP
704. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
706. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
708. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
710. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
712. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ASSIGNED
714. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
716. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
718. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
720. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
722. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
724. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
726. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
728. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
730. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
732. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
734. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
736. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
738. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
740. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ORG
742. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
744. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
746. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
748. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
750. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
752. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
754. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
756. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
758. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
760. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
762. ClinicalDocument.legalAuthenticator
Comments | SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
764. ClinicalDocument.legalAuthenticator.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
766. ClinicalDocument.legalAuthenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | LA
768. ClinicalDocument.legalAuthenticator.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
770. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
772. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
774. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
776. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
778. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
780. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
782. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
784. ClinicalDocument.legalAuthenticator.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
786. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
788. ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
790. ClinicalDocument.legalAuthenticator.signatureCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
792. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
794. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
796. ClinicalDocument.legalAuthenticator.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
798. ClinicalDocument.legalAuthenticator.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
800. ClinicalDocument.legalAuthenticator.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
802. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Short | The 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
804. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
806. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
808. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
810. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
812. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
814. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
816. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
818. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
820. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
822. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
824. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
826. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
828. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
830. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
832. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
834. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
836. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
838. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
840. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
842. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
844. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
846. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
848. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
850. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
852. ClinicalDocument.authenticator
Comments | MAY contain zero or more [0..*] authenticator (CONF:4537-5607) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
Slicing | This 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
854. ClinicalDocument.authenticator:authenticator1
Slice Name | authenticator1
Short | authenticator
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
856. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
858. ClinicalDocument.authenticator:authenticator1.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUTHEN
860. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
862. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
864. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
866. 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.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time (DTM.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
868. ClinicalDocument.authenticator:authenticator1.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
870. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
872. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | S
874. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
876. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
878. ClinicalDocument.authenticator:authenticator1.signatureCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
880. 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.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
882. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
884. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
886. ClinicalDocument.authenticator:authenticator1.signatureCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
888. ClinicalDocument.authenticator:authenticator1.signatureCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
890. ClinicalDocument.authenticator:authenticator1.signatureCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
892. ClinicalDocument.authenticator:authenticator1.sdtcSignatureText
Definition | Element Authenticator.sdtcSignatureText
Short | The 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`signatureText`.
894. ClinicalDocument.authenticator:authenticator1.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
896. ClinicalDocument.authenticator:authenticator1.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
898. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
900. ClinicalDocument.authenticator:authenticator1.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
902. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
904. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
906. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
908. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
910. ClinicalDocument.authenticator:authenticator1.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
912. ClinicalDocument.authenticator:authenticator1.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
914. ClinicalDocument.authenticator:authenticator1.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
916. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
918. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
920. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
922. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
924. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
926. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
928. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
930. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
932. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
934. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
936. ClinicalDocument.authenticator:authenticator1.assignedEntity.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
938. 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.
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
940. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
942. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
944. ClinicalDocument.authenticator:authenticator1.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
946. 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.
Control | 0..*
Type | Choice 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 Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
948. 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).
Control | 0..1
Binding | The codes SHALL be taken from Telecom Use (US Realm Header)
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
950. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
952. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PSN
954. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | INSTANCE
956. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
958. 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).
Short | Base 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).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier | false
Invariants | ele-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). ()
960. ClinicalDocument.authenticator:authenticator1.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
962. ClinicalDocument.authenticator:authenticator1.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
964. ClinicalDocument.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants | 4537-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). ()
966. ClinicalDocument.participant.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
968. ClinicalDocument.participant.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
970. ClinicalDocument.participant.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from ContextControl
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OP
972. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
974. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
976. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
978. ClinicalDocument.participant.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
980. ClinicalDocument.participant.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-10004).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
982. ClinicalDocument.participant.associatedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
984. ClinicalDocument.inFulfillmentOf
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:4537-9952).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
986. ClinicalDocument.inFulfillmentOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
988. ClinicalDocument.inFulfillmentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | FLFS
990. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
992. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
994. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
996. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
998. ClinicalDocument.inFulfillmentOf.order.classCode
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
1000. ClinicalDocument.inFulfillmentOf.order.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMoodIntent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RQO
1002. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1004. ClinicalDocument.inFulfillmentOf.order.id
Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1006. ClinicalDocument.inFulfillmentOf.order.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1008. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActPriority
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1010. ClinicalDocument.documentationOf
Short | The documentationOf relationship in a Continuity Care Document contains the representation of providers who are wholly or partially responsible for the safety and well-being of a subject of care.
Comments | SHALL contain exactly one [1..1] documentationOf (CONF:1198-8452).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
1012. ClinicalDocument.documentationOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1014. ClinicalDocument.documentationOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DOC
1016. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1018. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1020. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1022. ClinicalDocument.documentationOf.serviceEvent
Short | The main activity being described by a CCD is the provision of healthcare over a period of time. This is shown by setting the value of serviceEvent/@classCode to 'PCPR' (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). NOTE: Implementations originating a CCD should take care to discover what the episode of care being summarized is. For example, when a patient fills out a form providing relevant health history, the episode of care being documented might be from birth to the present.
Comments | This documentationOf SHALL contain exactly one [1..1] serviceEvent (CONF:1198-8480).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
1024. ClinicalDocument.documentationOf.serviceEvent.classCode
Comments | This serviceEvent SHALL contain exactly one [1..1] @classCode="PCPR" Care Provision (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8453).
Control | 1..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | ACT
Fixed Value | PCPR
1026. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1028. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1030. ClinicalDocument.documentationOf.serviceEvent.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1032. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1034. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8481).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1036. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1038. 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.
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
1040. 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.
Control | 0..1
Binding | The codes SHALL be taken from SetOperator
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | I
1042. 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:1198-8454).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
1044. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Label | Central Value
1046. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label | Width
1048. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] high (CONF:1198-8455).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
1050. ClinicalDocument.documentationOf.serviceEvent.performer
Short | The serviceEvent/performer represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare providers would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-8482).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
1052. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1054. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode="PRF" Participation physical performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8458).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | PRF
1056. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1058. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1060. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1062. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1064. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1066. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Care Team Member Function
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
1068. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
1070. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
1072. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
1074. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
1076. 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
1078. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
1080. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
1082. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
1084. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
1086. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1088. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Short | SG 20230709: Illegal constraint - base has min = 1 (deleted min=0)
Comments | The performer, if present, MAY contain zero or one [0..1] assignedEntity (CONF:1198-8459).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1090. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ASSIGNED
1092. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1094. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | The assignedEntity, if present, SHALL contain at least one [1..*] id (CONF:1198-30882).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | 1198-32466: If this assignedEntity is an assignedPerson, the assignedEntity/id **SHOULD** contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:1198-32466). ()
1096. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1098. 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
1100. 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
1102. 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).
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.4.6
1104. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
1106. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Definition | Element AssignedEntity.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
1108. 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).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1110. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1112. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1114. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Comments | The assignedEntity, if present, MAY contain zero or one [0..1] assignedPerson (CONF:1198-32467).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1116. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1118. ClinicalDocument.relatedDocument
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
1120. ClinicalDocument.authorization
Comments | MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authorization
1122. ClinicalDocument.authorization.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1124. ClinicalDocument.authorization.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | AUTH
1126. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1128. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1130. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1132. ClinicalDocument.authorization.consent
Comments | SHALL contain exactly one [1..1] consent (CONF:4537-16793).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Consent
1134. ClinicalDocument.authorization.consent.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | CONS
1136. ClinicalDocument.authorization.consent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1138. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1140. ClinicalDocument.authorization.consent.id
Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1142. ClinicalDocument.authorization.consent.code
Short | The 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).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1144. ClinicalDocument.authorization.consent.statusCode
Comments | This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1146. 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).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | completed
1148. ClinicalDocument.componentOf
Comments | MAY contain zero or one [0..1] componentOf (CONF:4537-9955).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
1150. ClinicalDocument.componentOf.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1152. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1154. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1156. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1158. ClinicalDocument.componentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1160. ClinicalDocument.componentOf.encompassingEncounter
Comments | The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
1162. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClass
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | ENC
1164. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1166. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1168. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1170. ClinicalDocument.componentOf.encompassingEncounter.code
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1172. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments | This encompassingEncounter SHALL contain exactly one [1..1] effectiveTime (CONF:4537-9958).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1174. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`admissionReferralSourceCode`.
1176. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from USEncounterDischargeDisposition
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1178. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1180. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1182. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1184. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1186. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1188. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationType
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | RESP
1190. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1192. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
1194. 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).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1196. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1198. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1200. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1202. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1204. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetLocation
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | LOC
1206. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
1208. ClinicalDocument.component
Comments | SHALL contain exactly one [1..1] component (CONF:1198-30659).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component
1210. ClinicalDocument.component.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1212. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1214. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1216. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1218. ClinicalDocument.component.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1220. ClinicalDocument.component.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1222. ClinicalDocument.component.nonXMLBody
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody
1224. ClinicalDocument.component.structuredBody
Comments | This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30660).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
1226. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1228. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1230. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1232. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1234. ClinicalDocument.component.structuredBody.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClassRecordOrganizer
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | DOCBODY
1236. ClinicalDocument.component.structuredBody.moodCode
Control | 0..1
Binding | The codes SHALL be taken from ActMood
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
1238. ClinicalDocument.component.structuredBody.confidentialityCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1240. ClinicalDocument.component.structuredBody.languageCode
Control | 0..1
Binding | The codes SHALL be taken from HumanLanguage
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1242. ClinicalDocument.component.structuredBody.component
Control | 6..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This 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
1244. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1246. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1248. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1250. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1252. ClinicalDocument.component.structuredBody.component.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1254. ClinicalDocument.component.structuredBody.component.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1256. ClinicalDocument.component.structuredBody.component.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
1258. ClinicalDocument.component.structuredBody.component:allergies
Slice Name | allergies
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30661).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1260. ClinicalDocument.component.structuredBody.component:allergies.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1262. ClinicalDocument.component.structuredBody.component:allergies.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1264. ClinicalDocument.component.structuredBody.component:allergies.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1266. ClinicalDocument.component.structuredBody.component:allergies.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1268. ClinicalDocument.component.structuredBody.component:allergies.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1270. ClinicalDocument.component.structuredBody.component:allergies.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1272. ClinicalDocument.component.structuredBody.component:allergies.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Comments | This component 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-30662).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Allergies and Intolerances Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1274. ClinicalDocument.component.structuredBody.component:medications
Slice Name | medications
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30663) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1276. ClinicalDocument.component.structuredBody.component:medications.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1278. ClinicalDocument.component.structuredBody.component:medications.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1280. ClinicalDocument.component.structuredBody.component:medications.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1282. ClinicalDocument.component.structuredBody.component:medications.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1284. ClinicalDocument.component.structuredBody.component:medications.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1286. ClinicalDocument.component.structuredBody.component:medications.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1288. ClinicalDocument.component.structuredBody.component:medications.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30664).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Medications Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1290. ClinicalDocument.component.structuredBody.component:problems
Slice Name | problems
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30665) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1292. ClinicalDocument.component.structuredBody.component:problems.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1294. ClinicalDocument.component.structuredBody.component:problems.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1296. ClinicalDocument.component.structuredBody.component:problems.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1298. ClinicalDocument.component.structuredBody.component:problems.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1300. ClinicalDocument.component.structuredBody.component:problems.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1302. ClinicalDocument.component.structuredBody.component:problems.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1304. ClinicalDocument.component.structuredBody.component:problems.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30666).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Problem Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1306. ClinicalDocument.component.structuredBody.component:procedures
Slice Name | procedures
Comments | This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30667) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1308. ClinicalDocument.component.structuredBody.component:procedures.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1310. ClinicalDocument.component.structuredBody.component:procedures.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1312. ClinicalDocument.component.structuredBody.component:procedures.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1314. ClinicalDocument.component.structuredBody.component:procedures.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1316. ClinicalDocument.component.structuredBody.component:procedures.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1318. ClinicalDocument.component.structuredBody.component:procedures.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1320. ClinicalDocument.component.structuredBody.component:procedures.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30668).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Procedures Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1322. ClinicalDocument.component.structuredBody.component:results
Slice Name | results
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30669) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1324. ClinicalDocument.component.structuredBody.component:results.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1326. ClinicalDocument.component.structuredBody.component:results.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1328. ClinicalDocument.component.structuredBody.component:results.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1330. ClinicalDocument.component.structuredBody.component:results.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1332. ClinicalDocument.component.structuredBody.component:results.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1334. ClinicalDocument.component.structuredBody.component:results.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1336. ClinicalDocument.component.structuredBody.component:results.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30670).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Results Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1338. ClinicalDocument.component.structuredBody.component:advDirectives
Slice Name | advDirectives
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30671) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1340. ClinicalDocument.component.structuredBody.component:advDirectives.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1342. ClinicalDocument.component.structuredBody.component:advDirectives.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1344. ClinicalDocument.component.structuredBody.component:advDirectives.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1346. ClinicalDocument.component.structuredBody.component:advDirectives.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1348. ClinicalDocument.component.structuredBody.component:advDirectives.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1350. ClinicalDocument.component.structuredBody.component:advDirectives.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1352. ClinicalDocument.component.structuredBody.component:advDirectives.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30672).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1354. ClinicalDocument.component.structuredBody.component:encounters
Slice Name | encounters
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30673) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1356. ClinicalDocument.component.structuredBody.component:encounters.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1358. ClinicalDocument.component.structuredBody.component:encounters.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1360. ClinicalDocument.component.structuredBody.component:encounters.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1362. ClinicalDocument.component.structuredBody.component:encounters.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1364. ClinicalDocument.component.structuredBody.component:encounters.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1366. ClinicalDocument.component.structuredBody.component:encounters.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1368. ClinicalDocument.component.structuredBody.component:encounters.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] Encounters Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.22.1:2015-08-01) (CONF:1198-30674).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Encounters Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1370. ClinicalDocument.component.structuredBody.component:famHistory
Slice Name | famHistory
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30675) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1372. ClinicalDocument.component.structuredBody.component:famHistory.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1374. ClinicalDocument.component.structuredBody.component:famHistory.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1376. ClinicalDocument.component.structuredBody.component:famHistory.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1378. ClinicalDocument.component.structuredBody.component:famHistory.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1380. ClinicalDocument.component.structuredBody.component:famHistory.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1382. ClinicalDocument.component.structuredBody.component:famHistory.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1384. ClinicalDocument.component.structuredBody.component:famHistory.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30676).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Family History Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1386. ClinicalDocument.component.structuredBody.component:functionalStatus
Slice Name | functionalStatus
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30677) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1388. ClinicalDocument.component.structuredBody.component:functionalStatus.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1390. ClinicalDocument.component.structuredBody.component:functionalStatus.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1392. ClinicalDocument.component.structuredBody.component:functionalStatus.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1394. ClinicalDocument.component.structuredBody.component:functionalStatus.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1396. ClinicalDocument.component.structuredBody.component:functionalStatus.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1398. ClinicalDocument.component.structuredBody.component:functionalStatus.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1400. ClinicalDocument.component.structuredBody.component:functionalStatus.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30678).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Functional Status Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1402. ClinicalDocument.component.structuredBody.component:immunizations
Slice Name | immunizations
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30679) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1404. ClinicalDocument.component.structuredBody.component:immunizations.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1406. ClinicalDocument.component.structuredBody.component:immunizations.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1408. ClinicalDocument.component.structuredBody.component:immunizations.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1410. ClinicalDocument.component.structuredBody.component:immunizations.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1412. ClinicalDocument.component.structuredBody.component:immunizations.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1414. ClinicalDocument.component.structuredBody.component:immunizations.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1416. ClinicalDocument.component.structuredBody.component:immunizations.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30680).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Immunizations Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1418. ClinicalDocument.component.structuredBody.component:medEquipment
Slice Name | medEquipment
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30681) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1420. ClinicalDocument.component.structuredBody.component:medEquipment.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1422. ClinicalDocument.component.structuredBody.component:medEquipment.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1424. ClinicalDocument.component.structuredBody.component:medEquipment.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1426. ClinicalDocument.component.structuredBody.component:medEquipment.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1428. ClinicalDocument.component.structuredBody.component:medEquipment.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1430. ClinicalDocument.component.structuredBody.component:medEquipment.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1432. ClinicalDocument.component.structuredBody.component:medEquipment.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30682).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Medical Equipment Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1434. ClinicalDocument.component.structuredBody.component:payers
Slice Name | payers
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30683) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1436. ClinicalDocument.component.structuredBody.component:payers.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1438. ClinicalDocument.component.structuredBody.component:payers.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1440. ClinicalDocument.component.structuredBody.component:payers.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1442. ClinicalDocument.component.structuredBody.component:payers.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1444. ClinicalDocument.component.structuredBody.component:payers.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1446. ClinicalDocument.component.structuredBody.component:payers.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1448. ClinicalDocument.component.structuredBody.component:payers.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Comments | SHALL contain exactly one [1..1] Payers Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.18:2015-08-01) (CONF:1198-30684).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Payers Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1450. ClinicalDocument.component.structuredBody.component:planOfTreatment
Slice Name | planOfTreatment
Comments | This structuredBody SHOULD contain zero or one [0..1] component (CONF:1198-30685) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1452. ClinicalDocument.component.structuredBody.component:planOfTreatment.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1454. ClinicalDocument.component.structuredBody.component:planOfTreatment.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1456. ClinicalDocument.component.structuredBody.component:planOfTreatment.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1458. ClinicalDocument.component.structuredBody.component:planOfTreatment.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1460. ClinicalDocument.component.structuredBody.component:planOfTreatment.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1462. ClinicalDocument.component.structuredBody.component:planOfTreatment.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1464. ClinicalDocument.component.structuredBody.component:planOfTreatment.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30686).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1466. ClinicalDocument.component.structuredBody.component:socialHist
Slice Name | socialHist
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30687) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1468. ClinicalDocument.component.structuredBody.component:socialHist.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1470. ClinicalDocument.component.structuredBody.component:socialHist.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1472. ClinicalDocument.component.structuredBody.component:socialHist.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1474. ClinicalDocument.component.structuredBody.component:socialHist.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1476. ClinicalDocument.component.structuredBody.component:socialHist.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1478. ClinicalDocument.component.structuredBody.component:socialHist.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1480. ClinicalDocument.component.structuredBody.component:socialHist.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30688).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Social History Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1482. ClinicalDocument.component.structuredBody.component:vitalSigns
Slice Name | vitalSigns
Comments | This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30689) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1484. ClinicalDocument.component.structuredBody.component:vitalSigns.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1486. ClinicalDocument.component.structuredBody.component:vitalSigns.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1488. ClinicalDocument.component.structuredBody.component:vitalSigns.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1490. ClinicalDocument.component.structuredBody.component:vitalSigns.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1492. ClinicalDocument.component.structuredBody.component:vitalSigns.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1494. ClinicalDocument.component.structuredBody.component:vitalSigns.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1496. ClinicalDocument.component.structuredBody.component:vitalSigns.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-30690).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Vital Signs Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1498. ClinicalDocument.component.structuredBody.component:mentalStatus
Slice Name | mentalStatus
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32143) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1500. ClinicalDocument.component.structuredBody.component:mentalStatus.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1502. ClinicalDocument.component.structuredBody.component:mentalStatus.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1504. ClinicalDocument.component.structuredBody.component:mentalStatus.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1506. ClinicalDocument.component.structuredBody.component:mentalStatus.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1508. ClinicalDocument.component.structuredBody.component:mentalStatus.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1510. ClinicalDocument.component.structuredBody.component:mentalStatus.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1512. ClinicalDocument.component.structuredBody.component:mentalStatus.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-32144).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Mental Status Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1514. ClinicalDocument.component.structuredBody.component:nutrition
Slice Name | nutrition
Comments | This structuredBody MAY contain zero or one [0..1] component (CONF:1198-32624) such that it
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1516. ClinicalDocument.component.structuredBody.component:nutrition.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
1518. ClinicalDocument.component.structuredBody.component:nutrition.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
1520. ClinicalDocument.component.structuredBody.component:nutrition.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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1522. ClinicalDocument.component.structuredBody.component:nutrition.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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1524. ClinicalDocument.component.structuredBody.component:nutrition.typeCode
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | COMP
1526. ClinicalDocument.component.structuredBody.component:nutrition.contextConductionInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | true
1528. ClinicalDocument.component.structuredBody.component:nutrition.section
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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-32625).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Nutrition Section)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)