Advance Healthcare Directive Interoperability (cda-adi)
0.1.0 - ci-build

Advance Healthcare Directive Interoperability (cda-adi), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cda-adi/ and changes regularly. See the Directory of published versions

## Logical Model: PersonalAdvanceCarePlanDocument - Detailed Descriptions

Active as of 2026-05-29

Definitions for the PersonalACPDocument logical model.

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

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

0. ClinicalDocument
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
Logical Container | ClinicalDocument (CDA Class)
Validation | Instance of this type are validated by templateId
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (`setId.exists() implies versionNumber.exists()`) 4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). (`versionNumber.exists() implies setId.exists()`) should-legalAuthenticator: SHOULD contain legalAuthenticator (`legalAuthenticator.exists()`) should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant (`participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()`)
2. ClinicalDocument.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
4. ClinicalDocument.classCode
Control | 0..1
Binding | For example codes, see CDAActClass (example to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
6. ClinicalDocument.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
8. 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
10. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
12. 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`
14. 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
16. 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
18. 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
20. 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
22. 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`.
24. 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`.
26. 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
28. 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
30. 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
32. ClinicalDocument.typeId
Definition | ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).
Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
34. ClinicalDocument.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
36. ClinicalDocument.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
38. ClinicalDocument.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
40. ClinicalDocument.typeId.root
Definition | Identifies the type as an HL7 Registered model
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(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
Fixed Value | `2.16.840.1.113883.1.3`
42. ClinicalDocument.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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.
Label | Extension
Fixed Value | `POCD_HD000040`
44. 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 | 3..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
46. 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
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
48. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
50. 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
52. 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
54. 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.
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`
56. ClinicalDocument.templateId:us-realm.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | `2024-05-01`
58. ClinicalDocument.templateId:us-patient-gen-doc
Slice Name | us-patient-gen-doc
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 | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
60. ClinicalDocument.templateId:us-patient-gen-doc.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
62. ClinicalDocument.templateId:us-patient-gen-doc.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
64. ClinicalDocument.templateId:us-patient-gen-doc.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
66. ClinicalDocument.templateId:us-patient-gen-doc.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
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.29.1`
68. ClinicalDocument.templateId:us-patient-gen-doc.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | `2024-05-01`
70. ClinicalDocument.templateId:personal-acp
Slice Name | personal-acp
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 | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
72. ClinicalDocument.templateId:personal-acp.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
74. ClinicalDocument.templateId:personal-acp.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
76. ClinicalDocument.templateId:personal-acp.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
78. ClinicalDocument.templateId:personal-acp.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
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.823.1.1.1`
80. ClinicalDocument.templateId:personal-acp.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | `2026-08-28`
82. ClinicalDocument.id
Definition | Represents the unique instance identifier of a clinical document.
Short | **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
Comments | This is the master identifier in a DocumentReference document indexing resource.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
84. ClinicalDocument.sdtcCategory
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Must Support | true
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`category`.
Slicing | This element introduces a set of slices on `ClinicalDocument.sdtcCategory`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ code value @ codeSystem
86. ClinicalDocument.sdtcCategory:ahdDocumentClass
Slice Name | ahdDocumentClass
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
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`category`.
88. ClinicalDocument.sdtcCategory:ahdDocumentClass.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
90. ClinicalDocument.sdtcCategory:ahdDocumentClass.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.
Short | Used to categorize the document type as an Advance Healthcare Directive
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 | `42348-3`
92. ClinicalDocument.sdtcCategory:ahdDocumentClass.codeSystem
Definition | Specifies the code system that defines the code.
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`
94. ClinicalDocument.sdtcCategory:ahdDocumentClass.codeSystemName
Definition | The common name of the coding system.
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 | Code System Name
Pattern Value | `LOINC`
96. ClinicalDocument.sdtcCategory:ahdDocumentClass.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
98. ClinicalDocument.sdtcCategory:ahdDocumentClass.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
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 | Display Name
100. ClinicalDocument.sdtcCategory:ahdDocumentClass.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`.
102. ClinicalDocument.sdtcCategory:ahdDocumentClass.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`.
104. ClinicalDocument.sdtcCategory:ahdDocumentClass.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
106. ClinicalDocument.sdtcCategory:ahdDocumentClass.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
108. ClinicalDocument.sdtcCategory:ahdDocumentClass.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
110. ClinicalDocument.sdtcCategory:pacpDocumentClass
Slice Name | pacpDocumentClass
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Must Support | true
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`category`.
112. ClinicalDocument.sdtcCategory:pacpDocumentClass.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
114. ClinicalDocument.sdtcCategory:pacpDocumentClass.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.
Short | Used to categorize the document type as a Patient-Authored Consent Document
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 | `59284-0`
116. ClinicalDocument.sdtcCategory:pacpDocumentClass.codeSystem
Definition | Specifies the code system that defines the code.
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`
118. ClinicalDocument.sdtcCategory:pacpDocumentClass.codeSystemName
Definition | The common name of the coding system.
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 | Code System Name
Pattern Value | `LOINC`
120. ClinicalDocument.sdtcCategory:pacpDocumentClass.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
122. ClinicalDocument.sdtcCategory:pacpDocumentClass.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
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 | Display Name
124. ClinicalDocument.sdtcCategory:pacpDocumentClass.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`.
126. ClinicalDocument.sdtcCategory:pacpDocumentClass.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`.
128. ClinicalDocument.sdtcCategory:pacpDocumentClass.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
130. ClinicalDocument.sdtcCategory:pacpDocumentClass.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
132. ClinicalDocument.sdtcCategory:pacpDocumentClass.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
134. ClinicalDocument.code
Definition | The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).
Short | This profile is used to represent a person-authored advance healthcare directive document. A person authored advance healthcare directive document is categorized as a consent document. This sub-category of advance healthcare directive documents expresses the patient’s own preferences as opposed to provider-authored advance healthcare directive documents which establish portable medical orders for the patient. This sub-category of advance healthcare directive document always is authored by the subject of the document (the patient). If care providers are involved in the creation of these types of documents, they may be included as facilitators. The patient (or their representative) is required to sign the document and is represented as an authenticator. Others who sign the document are represented as authenticators with their role such as witness or notary also included. It includes a presentation of the original source form of the completed document. It includes information about the person’s appointed healthcare agent(s), and may additionally include treatment intervention and care experience preferences under potential future health scenarios, administrative and completion information, additional documentation, and witness and notary information. The document always contains the source form in the Source Form section. It may include textual information present in the source form, organized in standard structural sections which may or may not include machine processable encoded entries.
Comments | SHALL contain exactly one [1..1] code.
Control | 1..1
Binding | The codes SHALL be taken from Advance Directive Document Types (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.22` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
136. 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..0
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
138. 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.
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
140. ClinicalDocument.code.codeSystem
Definition | Specifies the code system that defines the code.
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`
142. 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
144. 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
146. 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
148. 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`.
150. 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`.
152. 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
154. 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
156. 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
158. 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
160. ClinicalDocument.sdtcStatusCode
Definition | The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.
Comments | sdtc:statusCode is #completed is for documents where all activities required for a valid document have been completed, #new is for new documents or document versions that have not been completed yet.
Control | 1..1
Binding | The codes SHALL be taken from ActStatus (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
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`statusCode`.
162. ClinicalDocument.effectiveTime
Definition | Signifies the document creation time, when the document first came into being.
Short | The system origination time
Comments | Use miliseconds and the relevant timezone offset from UTC to explicitly state the timezone of the document's author and to support federated document management.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
164. ClinicalDocument.confidentialityCode
Short | Controls the disclosure of information in this document
Comments | Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
166. ClinicalDocument.confidentialityCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..0
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
168. ClinicalDocument.confidentialityCode.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
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926` )
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
170. ClinicalDocument.confidentialityCode.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
172. ClinicalDocument.confidentialityCode.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
174. ClinicalDocument.confidentialityCode.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
176. ClinicalDocument.confidentialityCode.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
178. ClinicalDocument.confidentialityCode.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`.
180. ClinicalDocument.confidentialityCode.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`.
182. ClinicalDocument.confidentialityCode.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
184. ClinicalDocument.confidentialityCode.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
186. ClinicalDocument.confidentialityCode.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
188. ClinicalDocument.languageCode
Definition | Specifies the human language of character data (whether they be in contents or attribute values).
Short | Human language of character data
Comments | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.
Control | 1..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
190. ClinicalDocument.setId
Short | Identifier a single logical document
Comments | Identifies all versions of a single logical document
Control | 1..1 This element is affected by the following invariants: 4537-6380, 4537-6387
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
192. ClinicalDocument.versionNumber
Short | The distinct version of a logical document
Comments | Used in conjunction with setId to identify a distinct version of a logical document
Control | 1..1 This element is affected by the following invariants: 4537-6380, 4537-6387
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
194. ClinicalDocument.copyTime
Definition | Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.
Short | Deprecated - use is discouraged
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Requirements | Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.
196. ClinicalDocument.recordTarget
Short | The recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. If the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA. HL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded.
Comments | SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
Requirements | The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.
198. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
200. 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
202. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
204. ClinicalDocument.recordTarget.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
206. ClinicalDocument.recordTarget.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
208. ClinicalDocument.recordTarget.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
210. ClinicalDocument.recordTarget.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
212. ClinicalDocument.recordTarget.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
214. 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
216. ClinicalDocument.recordTarget.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
218. ClinicalDocument.recordTarget.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
220. ClinicalDocument.recordTarget.patientRole
Comments | This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
222. ClinicalDocument.recordTarget.patientRole.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
224. ClinicalDocument.recordTarget.patientRole.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
226. ClinicalDocument.recordTarget.patientRole.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
228. ClinicalDocument.recordTarget.patientRole.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
230. ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
232. ClinicalDocument.recordTarget.patientRole.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
234. ClinicalDocument.recordTarget.patientRole.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
236. ClinicalDocument.recordTarget.patientRole.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
238. 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
240. ClinicalDocument.recordTarget.patientRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassRelationshipFormal (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal|3.0.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.
Fixed Value | `PAT`
242. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
244. 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`.
246. ClinicalDocument.recordTarget.patientRole.addr
Short | 𝗨𝗦𝗖𝗗𝗜: Address
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)
248. ClinicalDocument.recordTarget.patientRole.telecom
Short | 𝗨𝗦𝗖𝗗𝗜: Phone Number / Email
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
250. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
252. 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.
254. 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
256. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
258. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (`sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()`) 4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true (`sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')`) should-maritalStatusCode: SHOULD contain maritalStatusCode (`maritalStatusCode.exists()`) should-us-languageCommunication: SHOULD contain languageCommunication (`languageCommunication.exists()`) should-languageCommunication: SHOULD contain languageCommunication (`languageCommunication.exists()`)
260. ClinicalDocument.recordTarget.patientRole.patient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
262. ClinicalDocument.recordTarget.patientRole.patient.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
264. ClinicalDocument.recordTarget.patientRole.patient.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
266. ClinicalDocument.recordTarget.patientRole.patient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
268. ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
270. ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
272. ClinicalDocument.recordTarget.patientRole.patient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
274. ClinicalDocument.recordTarget.patientRole.patient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
276. 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
278. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
280. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
282. ClinicalDocument.recordTarget.patientRole.patient.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
284. ClinicalDocument.recordTarget.patientRole.patient.name
Definition | A name associated with the individual.
Short | A 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()))
286. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
288. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Control | 0..1
Binding | For example codes, see AdministrativeGender (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
290. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Short | 𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)
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 | ts-shall-year: **SHALL** be precise to at least the year (`nullFlavor.exists() or value.toString().length() >= 4`) ts-should-day: **SHOULD** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`)
292. 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`.
294. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | 𝗨𝗦𝗖𝗗𝗜: Date of Death
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`.
Invariants | should-value-att: SHOULD contain @value (`value.exists()`) ts-shall-year: **SHALL** be precise to at least the year (`nullFlavor.exists() or value.toString().length() >= 4`) ts-should-day: **SHOULD** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`)
296. 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`.
298. 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`.
300. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
Short | SHOULD contain 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 This element is affected by the following invariants: should-maritalStatusCode
Binding | The codes SHALL be taken from Marital Status (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
302. 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 (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
304. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Short | 𝗨𝗦𝗖𝗗𝗜: Race - raceCode SHALL contain only the OMB race category; detailed race values go in translation. Additional race categories are conveyed using sdtc:raceCode, following the same pattern (OMB category in root; details in translation).
Control | 1..1
Binding | The codes SHALL be taken from Race Categories (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.2.575` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
306. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
308. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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 | 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.
Label | Code
310. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
312. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
314. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
316. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
318. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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`.
320. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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`.
322. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
324. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
326. ClinicalDocument.recordTarget.patientRole.patient.raceCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Binding | The codes SHOULD be taken from Race Value Set (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914` )
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
Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. (`(code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()`)
328. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short | 𝗨𝗦𝗖𝗗𝗜: Race - 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.
Control | 0..*
Binding | The codes SHALL be taken from Detailed race including absence reasons. (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.25` )
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 | sdtc-race-not-detail: When using translation to convey race details, the base code SHALL be a race category. (`translation.exists(codeSystem = '2.16.840.1.113883.6.238') implies (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1'))`)
330. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
332. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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 | 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.
Label | Code
334. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
336. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
338. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
340. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
342. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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`.
344. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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`.
346. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
348. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
350. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Binding | The codes SHOULD be taken from Race Value Set (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914` )
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
Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. (`(code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()`)
352. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity Categories (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.3` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
354. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity
Control | 0..*
Binding | The codes SHALL be taken from Detailed Ethnicity Including Absence Reasons (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.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`ethnicGroupCode`.
356. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
Invariants | should-us-code: SHOULD contain code (`code.exists()`) should-us-addr: SHOULD contain addr (`addr.exists()`) should-us-telecom: SHOULD contain telecom (`telecom.exists()`) should-id: SHOULD contain id (`id.exists()`) should-code: SHOULD contain code (`code.exists()`)
358. ClinicalDocument.recordTarget.patientRole.patient.guardian.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
360. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
362. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
364. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
366. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
368. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
370. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
372. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
374. 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
376. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAgent (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent|3.0.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.
Fixed Value | `GUARD`
378. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Comments | The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
380. 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`.
382. 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:1198-28473).
Control | 0..1
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
384. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
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)
386. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
388. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
390. 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.
392. 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
394. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
396. 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
398. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
400. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
402. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
404. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
406. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
408. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
410. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
412. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
414. 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
416. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
418. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
420. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
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). 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()))
422. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
424. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
426. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
428. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
430. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
432. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
434. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
436. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
438. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
440. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
442. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
444. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
446. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
448. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
450. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
452. 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
454. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
456. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
458. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
460. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
462. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
464. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
466. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
468. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
470. 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
472. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassPassive (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassPassive|3.0.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.
Fixed Value | `BIRTHPL`
474. 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
476. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
478. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
480. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
482. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
484. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
486. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
488. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
490. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
492. 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
494. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassPlace|3.0.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.
Fixed Value | `PLC`
496. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
498. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
500. 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 US Core USPS State *DYNAMIC* (CONF:4537-5402). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://terminology.hl7.org/ValueSet/USPS-State'))`) 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). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))`) should-country: SHOULD contain country (`nullFlavor.exists() or item.country.exists()`)
502. 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.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
504. 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
506. 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..*
Binding | The codes SHALL be taken from CDAPostalAddressUse (required to `http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse` )
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
508. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
Definition | A series of items that constitute the address.
Control | 0..*
Type | http://hl7.org/fhir/StructureDefinition/Base
Choice Group | This is a repeating choice group that does not appear directly in the instance
Invariants | AD-1: Can only have only one of the possible item elements in each choice (`(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1`)
510. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter
Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
512. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
514. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
516. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
518. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
520. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
522. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
524. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
Definition | Country
Control | 0..1
Binding | The codes SHALL be taken from Country2 (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-Country2|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
526. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
528. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
530. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
532. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
534. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
536. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
538. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state
Definition | A sub-unit of a country with limited sovereignty in a federally organized country.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
540. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
544. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
546. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
548. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
550. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
552. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
554. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
556. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
558. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
560. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
562. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
564. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
566. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city
Definition | The name of the city, town, village, or other community or delivery center
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
568. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
570. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
572. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
574. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
576. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
578. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
580. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
582. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
584. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
586. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
588. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
590. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
592. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
594. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine
Definition | Street address line
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
596. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
598. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
600. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
602. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
604. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
606. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
608. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
610. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
612. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
614. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
616. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
618. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
620. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
622. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric
Definition | The numeric portion of a building number
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
624. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
626. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
628. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
630. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
632. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
634. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
636. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction
Definition | Direction (e.g., N, S, W, E)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
638. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
640. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
642. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
644. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
646. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
648. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
650. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
652. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
654. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
656. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
658. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
660. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
662. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
664. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
666. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
668. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
670. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
672. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
674. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
676. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
678. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
680. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
682. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
684. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
686. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
688. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
690. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
692. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
694. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
696. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
698. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
700. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
702. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
704. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
706. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
708. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
710. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
712. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
714. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
716. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
718. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
720. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
722. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
724. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
726. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
728. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
730. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
732. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
734. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
736. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
738. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
740. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
742. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
744. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
746. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
748. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract
Definition | A geographic sub-unit delineated for demographic purposes.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
750. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
752. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
754. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
756. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
758. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
760. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
762. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
764. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
768. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
770. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
772. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
774. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
776. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
778. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
780. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
782. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
784. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
786. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
788. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
790. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
792. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
794. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
796. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
798. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
800. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
802. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
804. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
806. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
808. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
810. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
812. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
814. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
816. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
818. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
820. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
822. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
824. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
826. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
828. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
830. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
832. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
834. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
836. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
838. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
840. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
842. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
844. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
846. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
848. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
850. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
852. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
854. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
856. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
858. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
860. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox
Definition | A numbered box located in a post station.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
862. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
864. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
866. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
868. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
870. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
872. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
874. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct
Definition | A subsection of a municipality
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
876. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
878. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
880. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
882. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
884. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
886. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
888. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
890. 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
892. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Short | 𝗨𝗦𝗖𝗗𝗜: Preferred Language
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (`proficiencyLevelCode.exists()`) should-preferenceInd: SHOULD contain preferenceInd (`preferenceInd.exists()`)
894. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
896. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
898. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
900. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
902. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
904. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
906. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
908. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
910. 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
912. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Control | 1..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
914. 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 (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
916. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
Short | SHOULD contain 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 This element is affected by the following invariants: should-proficiencyLevelCode
Binding | The codes SHALL be taken from LanguageAbilityProficiency (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
918. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Short | Indicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language. If more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.
Comments | The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:1198-28475).
Control | 0..1 This element is affected by the following invariants: should-preferenceInd
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
920. ClinicalDocument.recordTarget.patientRole.providerOrganization
Short | If present, this organization represents the provider organization where the person is claiming to be a patient.
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
Label | If present, this organization represents the provider organization where the person is claiming to be a patient.
922. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
924. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
926. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
928. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
930. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
932. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
934. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
936. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
938. 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
940. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization|3.0.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.
Fixed Value | `ORG`
942. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
944. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417). Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 10..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
946. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
948. 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
950. 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
952. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
954. 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
956. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Definition | A name associated with the organization.
Short | Name used for the organization
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419). If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Control | 10..*1 This element is affected by the following invariants: org-1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON string
Is Modifier | false
Requirements | Need to use the name as the label of the organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
958. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
960. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
962. 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.
964. 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
966. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
968. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
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)
970. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
972. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
974. ClinicalDocument.author
Short | The author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.
Comments | SHALL contain at least one [1..*] author (CONF:1198-28477).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
976. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
978. 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
980. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
982. ClinicalDocument.author.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
984. ClinicalDocument.author.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
986. ClinicalDocument.author.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
988. ClinicalDocument.author.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
990. ClinicalDocument.author.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
992. 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
994. ClinicalDocument.author.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
996. ClinicalDocument.author.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
998. ClinicalDocument.author.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1000. ClinicalDocument.author.time
Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (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 - Point in Time)
1002. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478).
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). (`(assignedPerson | assignedAuthoringDevice).count() = 1`) should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) (`id.where(root = '2.16.840.1.113883.4.6')`) should-us-code: SHOULD contain code (`code.exists()`) should-code: SHOULD contain code (`code.exists()`)
1004. ClinicalDocument.author.assignedAuthor.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1006. ClinicalDocument.author.assignedAuthor.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
1008. ClinicalDocument.author.assignedAuthor.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1010. ClinicalDocument.author.assignedAuthor.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1012. ClinicalDocument.author.assignedAuthor.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1014. ClinicalDocument.author.assignedAuthor.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1016. ClinicalDocument.author.assignedAuthor.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1018. ClinicalDocument.author.assignedAuthor.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1020. 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
1022. ClinicalDocument.author.assignedAuthor.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1024. ClinicalDocument.author.assignedAuthor.id
Comments | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479).
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 areUnordered and Open, and can be differentiated using the following discriminators: value @ root
1026. ClinicalDocument.author.assignedAuthor.id:npi
Slice Name | npi
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | should-extension: SHOULD contain extension (`extension.exists()`)
1028. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Short | If NPI is unknown, set @nullFlavor to UNK
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1030. ClinicalDocument.author.assignedAuthor.id:npi.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
1032. ClinicalDocument.author.assignedAuthor.id:npi.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
1034. ClinicalDocument.author.assignedAuthor.id:npi.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`
1036. ClinicalDocument.author.assignedAuthor.id:npi.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
1038. 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`.
1040. ClinicalDocument.author.assignedAuthor.code
Short | When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-28481).
Control | 0..1
Binding | For example codes, see CDARoleCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1042. 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..0
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1044. 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.
Control | 1..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.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
1046. 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
1048. 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
1050. 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
1052. 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
1054. 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`.
1056. 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`.
1058. 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
1060. 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
1062. 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
1064. ClinicalDocument.author.assignedAuthor.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1066. ClinicalDocument.author.assignedAuthor.addr
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)
1068. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1070. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1072. 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.
1074. 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
1076. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1078. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | MAY contain assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1080. ClinicalDocument.author.assignedAuthor.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1082. ClinicalDocument.author.assignedAuthor.assignedPerson.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
1084. ClinicalDocument.author.assignedAuthor.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1086. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1088. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1090. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1092. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1094. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1096. 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
1098. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1100. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1102. ClinicalDocument.author.assignedAuthor.assignedPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
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). 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()))
1104. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1106. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1108. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1110. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1112. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1114. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1116. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1118. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1120. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1122. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1124. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1126. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1128. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1130. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1132. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | MAY contain assignedAuthoringDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
1134. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1136. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1138. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1140. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1142. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1144. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1146. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1148. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1150. 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
1152. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassDevice (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice|3.0.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.
Fixed Value | `DEV`
1154. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1156. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control | 0..1
Binding | For example codes, see CDAEntityCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1158. 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 ManufacturerModelNameExample (2.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample|2.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
1160. 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 SoftwareNameExample (2.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample|2.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
1162. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
1164. ClinicalDocument.author.assignedAuthor.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1166. ClinicalDocument.dataEnterer
Short | The dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:1198-28678).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
Alternate Names | Transcriptionist
1168. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1170. 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
1172. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1174. ClinicalDocument.dataEnterer.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1176. ClinicalDocument.dataEnterer.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1178. ClinicalDocument.dataEnterer.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1180. ClinicalDocument.dataEnterer.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1182. ClinicalDocument.dataEnterer.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1184. 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
1186. ClinicalDocument.dataEnterer.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1188. ClinicalDocument.dataEnterer.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1190. ClinicalDocument.dataEnterer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
1192. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1194. ClinicalDocument.dataEnterer.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1196. ClinicalDocument.dataEnterer.assignedEntity.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
1198. ClinicalDocument.dataEnterer.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1200. ClinicalDocument.dataEnterer.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1202. ClinicalDocument.dataEnterer.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1204. ClinicalDocument.dataEnterer.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1206. ClinicalDocument.dataEnterer.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1208. ClinicalDocument.dataEnterer.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1210. 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
1212. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1214. 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
1216. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1218. 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
1220. 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
1222. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
1224. 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
1226. ClinicalDocument.dataEnterer.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`.
1228. ClinicalDocument.dataEnterer.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1230. ClinicalDocument.dataEnterer.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1232. ClinicalDocument.dataEnterer.assignedEntity.addr
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)
1234. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1236. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1238. 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.
1240. 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
1242. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1244. 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
1246. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1248. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1250. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1252. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1254. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1256. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1258. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1260. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1262. 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
1264. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1266. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1268. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name
Definition | A name associated with the person.
Short | A 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-5470). 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()))
1270. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1272. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1274. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1276. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1278. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1280. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1282. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1284. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1286. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1288. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1290. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1292. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1294. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1296. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1298. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1300. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
1302. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
1304. ClinicalDocument.informant
Definition | An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.
Short | Person that provides relevant information
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 areUnordered and Open, and can be differentiated using the following discriminators: exists @ relatedEntity exists @ assignedEntity
1306. ClinicalDocument.informant:provider
Slice Name | provider
Definition | An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.
Short | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
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
1308. ClinicalDocument.informant:provider.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.informant:provider.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.informant:provider.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1314. ClinicalDocument.informant:provider.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1316. ClinicalDocument.informant:provider.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1318. ClinicalDocument.informant:provider.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1320. ClinicalDocument.informant:provider.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1322. ClinicalDocument.informant:provider.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1324. ClinicalDocument.informant:provider.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
1326. ClinicalDocument.informant:provider.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1328. ClinicalDocument.informant:provider.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1330. ClinicalDocument.informant:provider.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1332. ClinicalDocument.informant:provider.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1334. ClinicalDocument.informant:provider.assignedEntity.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
1336. ClinicalDocument.informant:provider.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1338. ClinicalDocument.informant:provider.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1340. ClinicalDocument.informant:provider.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1342. ClinicalDocument.informant:provider.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1344. ClinicalDocument.informant:provider.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1346. ClinicalDocument.informant:provider.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1348. ClinicalDocument.informant:provider.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
1350. ClinicalDocument.informant:provider.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1352. ClinicalDocument.informant:provider.assignedEntity.id
Short | 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).
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1354. ClinicalDocument.informant:provider.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`.
1356. ClinicalDocument.informant:provider.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 (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1358. ClinicalDocument.informant:provider.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1360. ClinicalDocument.informant:provider.assignedEntity.addr
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)
1362. ClinicalDocument.informant:provider.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1364. ClinicalDocument.informant:provider.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
1366. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1368. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1370. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1372. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.informant:provider.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1376. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1378. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1380. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1382. ClinicalDocument.informant:provider.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
1384. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1386. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1388. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name
Definition | A name associated with the person.
Short | A 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()))
1390. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1392. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1394. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1396. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1398. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1400. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1402. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1404. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1406. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1408. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1410. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1414. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1416. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1418. ClinicalDocument.informant:provider.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1420. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
1422. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
1424. ClinicalDocument.informant:provider.relatedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1426. ClinicalDocument.informant:non-provider
Slice Name | non-provider
Definition | An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.
Short | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
1428. ClinicalDocument.informant:non-provider.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1430. ClinicalDocument.informant:non-provider.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
1432. ClinicalDocument.informant:non-provider.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1434. ClinicalDocument.informant:non-provider.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1436. ClinicalDocument.informant:non-provider.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1438. ClinicalDocument.informant:non-provider.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1440. ClinicalDocument.informant:non-provider.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1442. ClinicalDocument.informant:non-provider.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1444. ClinicalDocument.informant:non-provider.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
1446. ClinicalDocument.informant:non-provider.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1448. ClinicalDocument.informant:non-provider.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1450. ClinicalDocument.informant:non-provider.assignedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1452. ClinicalDocument.informant:non-provider.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1454. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1456. ClinicalDocument.informant:non-provider.relatedEntity.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
1458. ClinicalDocument.informant:non-provider.relatedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1460. ClinicalDocument.informant:non-provider.relatedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1462. ClinicalDocument.informant:non-provider.relatedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1464. ClinicalDocument.informant:non-provider.relatedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1466. ClinicalDocument.informant:non-provider.relatedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1468. ClinicalDocument.informant:non-provider.relatedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1470. ClinicalDocument.informant:non-provider.relatedEntity.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
1472. ClinicalDocument.informant:non-provider.relatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from CDARoleClassMutualRelationship (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship` )
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.
1474. ClinicalDocument.informant:non-provider.relatedEntity.code
Comments | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683).
Control | 0..1
Binding | For example codes, see PersonalRelationshipRoleType (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | should-us-code-attr: SHOULD contain @code (`code.exists()`)
1476. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1478. ClinicalDocument.informant:non-provider.relatedEntity.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, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28684).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.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
1480. ClinicalDocument.informant:non-provider.relatedEntity.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
1482. ClinicalDocument.informant:non-provider.relatedEntity.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
1484. ClinicalDocument.informant:non-provider.relatedEntity.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
1486. ClinicalDocument.informant:non-provider.relatedEntity.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
1488. ClinicalDocument.informant:non-provider.relatedEntity.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`.
1490. ClinicalDocument.informant:non-provider.relatedEntity.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`.
1492. ClinicalDocument.informant:non-provider.relatedEntity.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
1494. ClinicalDocument.informant:non-provider.relatedEntity.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
1496. ClinicalDocument.informant:non-provider.relatedEntity.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
1498. ClinicalDocument.informant:non-provider.relatedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1500. ClinicalDocument.informant:non-provider.relatedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1502. ClinicalDocument.informant:non-provider.relatedEntity.effectiveTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1504. ClinicalDocument.informant:non-provider.relatedEntity.relatedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1506. ClinicalDocument.custodian
Definition | Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.
Short | The custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.
Comments | SHALL contain exactly one [1..1] custodian (CONF:1198-28685).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
Requirements | The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.
1508. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1510. 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
1512. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1514. ClinicalDocument.custodian.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1516. ClinicalDocument.custodian.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1518. ClinicalDocument.custodian.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1520. ClinicalDocument.custodian.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1522. ClinicalDocument.custodian.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1524. 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
1526. ClinicalDocument.custodian.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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 | `CST`
1528. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
1530. ClinicalDocument.custodian.assignedCustodian.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1532. ClinicalDocument.custodian.assignedCustodian.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
1534. ClinicalDocument.custodian.assignedCustodian.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1536. ClinicalDocument.custodian.assignedCustodian.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1538. ClinicalDocument.custodian.assignedCustodian.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1540. ClinicalDocument.custodian.assignedCustodian.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1542. ClinicalDocument.custodian.assignedCustodian.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1544. ClinicalDocument.custodian.assignedCustodian.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1546. 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
1548. ClinicalDocument.custodian.assignedCustodian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1550. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Short | The representedCustodianOrganization may be the person when the document is not maintained by an organization.
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-28687).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
1552. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1554. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1556. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1558. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1560. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1562. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1564. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1566. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1568. 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
1570. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization|3.0.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.
Fixed Value | `ORG`
1572. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1574. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Short | The combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-28688).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1576. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1578. 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
1580. 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
1582. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
1584. 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
1586. 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
1588. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1590. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1592. 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.
1594. 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
1596. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1598. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom
Short | The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
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`telecom`.
1600. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
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)
1602. ClinicalDocument.informationRecipient
Short | The informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:1198-28690).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
1604. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1606. 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
1608. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1610. ClinicalDocument.informationRecipient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1612. ClinicalDocument.informationRecipient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1614. ClinicalDocument.informationRecipient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1616. ClinicalDocument.informationRecipient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1618. ClinicalDocument.informationRecipient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1620. 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
1622. ClinicalDocument.informationRecipient.typeCode
Control | 0..1
Binding | The codes SHALL be taken from XInformationRecipient (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.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.
Default Value | `PRCP`
1624. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
Invariants | should-id: SHOULD contain id (`id.exists()`)
1626. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1628. ClinicalDocument.informationRecipient.intendedRecipient.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
1630. ClinicalDocument.informationRecipient.intendedRecipient.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1632. ClinicalDocument.informationRecipient.intendedRecipient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1634. ClinicalDocument.informationRecipient.intendedRecipient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1636. ClinicalDocument.informationRecipient.intendedRecipient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1638. ClinicalDocument.informationRecipient.intendedRecipient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1640. ClinicalDocument.informationRecipient.intendedRecipient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1642. 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
1644. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAInformationRecipientRole (required to `http://hl7.org/cda/stds/core/ValueSet/CDAInformationRecipientRole` )
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`
1646. ClinicalDocument.informationRecipient.intendedRecipient.id
Short | The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
Comments | This intendedRecipient SHOULD contain zero or more [0..*] id (CONF:1198-28692).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | should-root: SHOULD contain @root (`root.exists()`)
1648. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1650. ClinicalDocument.informationRecipient.intendedRecipient.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
1652. ClinicalDocument.informationRecipient.intendedRecipient.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
1654. ClinicalDocument.informationRecipient.intendedRecipient.id.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Short | For a provider, the id/@root ="2.16.840.1.113883.4.6" indicates the National Provider Identifier where id/@extension is the NPI number for the provider. The ids MAY reference the id of a person or organization entity specified elsewhere in the document.
Comments | The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693).
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
1656. ClinicalDocument.informationRecipient.intendedRecipient.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
1658. 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`.
1660. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1662. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1664. 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
1666. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1668. ClinicalDocument.informationRecipient.intendedRecipient.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
1670. ClinicalDocument.informationRecipient.intendedRecipient.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1672. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1674. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1676. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1678. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1680. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1682. 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
1684. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1686. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1688. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
Definition | A name associated with the person.
Short | A name associated with the person
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). 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()))
1690. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1692. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1694. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1696. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1698. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1700. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1702. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1704. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1706. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1708. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1710. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1712. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1714. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1716. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code
Control | 1..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`.
1718. 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
1720. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1722. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1724. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1726. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1728. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1730. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1732. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1734. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1736. 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
1738. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization|3.0.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.
Fixed Value | `ORG`
1740. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1742. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
1744. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Definition | A name associated with the organization.
Short | Name used for the organization
Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578). If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Control | 10..1 This element is affected by the following invariants: org-1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON string
Is Modifier | false
Requirements | Need to use the name as the label of the organization.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1746. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1748. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1750. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1752. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
1754. ClinicalDocument.legalAuthenticator
Short | In a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) Based on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Comments | MAY contain zero or one [0..1] legalAuthenticator (CONF:1198-28694).
Control | 0..1 This element is affected by the following invariants: should-legalAuthenticator
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Requirements | While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.
1756. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1758. 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
1760. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1762. ClinicalDocument.legalAuthenticator.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1764. ClinicalDocument.legalAuthenticator.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1766. ClinicalDocument.legalAuthenticator.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1768. ClinicalDocument.legalAuthenticator.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1770. ClinicalDocument.legalAuthenticator.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1772. 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
1774. ClinicalDocument.legalAuthenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1776. ClinicalDocument.legalAuthenticator.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1778. ClinicalDocument.legalAuthenticator.time
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (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 - Point in Time)
1780. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
Control | 1..1
Binding | The codes SHALL be taken from CDASignatureCode (required to `http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Invariants | signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (`code.exists() implies code != 'X'`)
1782. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1784. 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`
1786. 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
1788. 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
1790. 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
1792. 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
1794. 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`.
1796. 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`.
1798. 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
1800. 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
1802. 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
1804. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Definition | A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.
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. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013.
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`.
1806. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1808. ClinicalDocument.legalAuthenticator.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1810. ClinicalDocument.legalAuthenticator.assignedEntity.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
1812. ClinicalDocument.legalAuthenticator.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1814. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1816. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1818. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1820. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1822. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1824. 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
1826. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1828. ClinicalDocument.legalAuthenticator.assignedEntity.id
Short | The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28696).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1830. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1832. 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
1834. 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
1836. 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.
Short | MAY contain '2.16.840.1.113883.4.6' (NPI)
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
1838. 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
1840. ClinicalDocument.legalAuthenticator.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`.
1842. ClinicalDocument.legalAuthenticator.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1844. ClinicalDocument.legalAuthenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1846. ClinicalDocument.legalAuthenticator.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 Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28698).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.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
1848. ClinicalDocument.legalAuthenticator.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
1850. ClinicalDocument.legalAuthenticator.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
1852. ClinicalDocument.legalAuthenticator.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
1854. ClinicalDocument.legalAuthenticator.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
1856. ClinicalDocument.legalAuthenticator.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`.
1858. ClinicalDocument.legalAuthenticator.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`.
1860. ClinicalDocument.legalAuthenticator.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
1862. ClinicalDocument.legalAuthenticator.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
1864. ClinicalDocument.legalAuthenticator.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
1866. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1868. ClinicalDocument.legalAuthenticator.assignedEntity.addr
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)
1870. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1872. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1874. 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.
1876. 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
1878. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1880. 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
1882. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1884. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1886. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1888. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1890. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1892. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1894. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1896. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1898. 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
1900. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1902. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1904. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
Definition | A name associated with the person.
Short | A 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-5598). 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()))
1906. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1908. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1910. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1912. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1914. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1916. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1918. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1920. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1922. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1924. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1926. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1928. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1930. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1932. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1934. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1936. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
1938. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
1940. ClinicalDocument.authenticator
Definition | Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.
Short | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
Comments | MAY contain zero or more [0..*] authenticator (CONF:1198-28699).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
1942. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1944. ClinicalDocument.authenticator.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
1946. ClinicalDocument.authenticator.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1948. ClinicalDocument.authenticator.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1950. ClinicalDocument.authenticator.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1952. ClinicalDocument.authenticator.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1954. ClinicalDocument.authenticator.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1956. ClinicalDocument.authenticator.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1958. ClinicalDocument.authenticator.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
1960. ClinicalDocument.authenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1962. ClinicalDocument.authenticator.time
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (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 - Point in Time)
1964. ClinicalDocument.authenticator.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Binding | The codes SHALL be taken from CDASignatureCode (required to `http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Invariants | signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (`code.exists() implies code != 'X'`)
1966. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1968. ClinicalDocument.authenticator.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`
1970. ClinicalDocument.authenticator.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
1972. ClinicalDocument.authenticator.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
1974. ClinicalDocument.authenticator.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
1976. ClinicalDocument.authenticator.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
1978. ClinicalDocument.authenticator.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`.
1980. ClinicalDocument.authenticator.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`.
1982. ClinicalDocument.authenticator.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
1984. ClinicalDocument.authenticator.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
1986. ClinicalDocument.authenticator.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
1988. ClinicalDocument.authenticator.sdtcSignatureText
Definition | A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.
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. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.
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`.
1990. ClinicalDocument.authenticator.assignedEntity
Comments | The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-code: SHOULD contain code (`code.exists()`)
1992. ClinicalDocument.authenticator.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1994. ClinicalDocument.authenticator.assignedEntity.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
1996. ClinicalDocument.authenticator.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1998. ClinicalDocument.authenticator.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2000. ClinicalDocument.authenticator.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2002. ClinicalDocument.authenticator.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2004. ClinicalDocument.authenticator.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2006. ClinicalDocument.authenticator.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2008. ClinicalDocument.authenticator.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
2010. ClinicalDocument.authenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
2012. ClinicalDocument.authenticator.assignedEntity.id
Short | The combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2014. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2016. ClinicalDocument.authenticator.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
2018. ClinicalDocument.authenticator.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
2020. ClinicalDocument.authenticator.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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
2022. ClinicalDocument.authenticator.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
2024. ClinicalDocument.authenticator.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`.
2026. ClinicalDocument.authenticator.assignedEntity.code
Comments | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2028. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2030. ClinicalDocument.authenticator.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 (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` )
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
2032. ClinicalDocument.authenticator.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
2034. ClinicalDocument.authenticator.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
2036. ClinicalDocument.authenticator.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
2038. ClinicalDocument.authenticator.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
2040. ClinicalDocument.authenticator.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`.
2042. ClinicalDocument.authenticator.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`.
2044. ClinicalDocument.authenticator.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
2046. ClinicalDocument.authenticator.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
2048. ClinicalDocument.authenticator.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
2050. ClinicalDocument.authenticator.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
2052. ClinicalDocument.authenticator.assignedEntity.addr
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)
2054. ClinicalDocument.authenticator.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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
2056. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2058. ClinicalDocument.authenticator.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.
2060. ClinicalDocument.authenticator.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
2062. ClinicalDocument.authenticator.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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
2064. ClinicalDocument.authenticator.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
2066. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2068. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
2070. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2072. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2074. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2076. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2078. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2080. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2082. ClinicalDocument.authenticator.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
2084. ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
2086. ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
2088. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name
Definition | A name associated with the person.
Short | A 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()))
2090. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
2092. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
2094. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2096. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
2098. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2100. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2102. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2104. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2106. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2108. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2110. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
2112. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
2114. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
2116. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
2118. ClinicalDocument.authenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2120. ClinicalDocument.authenticator.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
2122. ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
2124. ClinicalDocument.participant
Definition | Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.
Short | The participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)
Comments | MAY contain zero or more [0..*] participant (CONF:1198-28703).
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). (`associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()`) 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). (`typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33')`)
2126. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2128. 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
2130. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2132. ClinicalDocument.participant.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2134. ClinicalDocument.participant.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2136. ClinicalDocument.participant.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2138. ClinicalDocument.participant.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2140. ClinicalDocument.participant.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2142. 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
2144. ClinicalDocument.participant.typeCode
Short | Unless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30
Comments | The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704).
Control | 1..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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.
2146. ClinicalDocument.participant.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
2148. ClinicalDocument.participant.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2150. 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(US Realm Date and Time - Interval)
2152. ClinicalDocument.participant.associatedEntity
Comments | The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
Invariants | should-code: SHOULD contain code (`code.exists()`)
2154. ClinicalDocument.participant.associatedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2156. ClinicalDocument.participant.associatedEntity.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
2158. ClinicalDocument.participant.associatedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2160. ClinicalDocument.participant.associatedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2162. ClinicalDocument.participant.associatedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2164. ClinicalDocument.participant.associatedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2166. ClinicalDocument.participant.associatedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2168. ClinicalDocument.participant.associatedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2170. ClinicalDocument.participant.associatedEntity.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2172. ClinicalDocument.participant.associatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from CDARoleClassAssociative (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative` )
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.
2174. ClinicalDocument.participant.associatedEntity.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2176. ClinicalDocument.participant.associatedEntity.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`.
2178. ClinicalDocument.participant.associatedEntity.code
Comments | This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2180. ClinicalDocument.participant.associatedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
2182. ClinicalDocument.participant.associatedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
2184. ClinicalDocument.participant.associatedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
2186. ClinicalDocument.participant.associatedEntity.associatedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
2188. ClinicalDocument.participant.associatedEntity.scopingOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2190. ClinicalDocument.inFulfillmentOf
Short | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray.
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
2192. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2194. 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
2196. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2198. ClinicalDocument.inFulfillmentOf.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2200. ClinicalDocument.inFulfillmentOf.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2202. ClinicalDocument.inFulfillmentOf.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2204. ClinicalDocument.inFulfillmentOf.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2206. ClinicalDocument.inFulfillmentOf.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2208. 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
2210. ClinicalDocument.inFulfillmentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipFulfills (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipFulfills|2.0.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.
Fixed Value | `FLFS`
2212. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
2214. ClinicalDocument.inFulfillmentOf.order.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2216. ClinicalDocument.inFulfillmentOf.order.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
2218. ClinicalDocument.inFulfillmentOf.order.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2220. ClinicalDocument.inFulfillmentOf.order.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2222. ClinicalDocument.inFulfillmentOf.order.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2224. ClinicalDocument.inFulfillmentOf.order.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2226. ClinicalDocument.inFulfillmentOf.order.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2228. ClinicalDocument.inFulfillmentOf.order.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2230. 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
2232. ClinicalDocument.inFulfillmentOf.order.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2234. ClinicalDocument.inFulfillmentOf.order.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMoodIntent (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent` )
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`
2236. ClinicalDocument.inFulfillmentOf.order.id
Short | A scheduled appointment or service event in a practice management system may be represented using this id element.
Comments | This order SHALL contain at least one [1..*] id (CONF:1198-28709).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2238. ClinicalDocument.inFulfillmentOf.order.code
Control | 0..1
Binding | For example codes, see ActCode (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2240. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2242. ClinicalDocument.documentationOf
Short | The main Act being documented
Comments | MAY contain zero or more [0..*] documentationOf (CONF:1198-28710).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
2244. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2246. 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
2248. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2250. ClinicalDocument.documentationOf.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2252. ClinicalDocument.documentationOf.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2254. ClinicalDocument.documentationOf.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2256. ClinicalDocument.documentationOf.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2258. ClinicalDocument.documentationOf.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2260. 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
2262. ClinicalDocument.documentationOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActRelationshipType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType` )
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`
2264. ClinicalDocument.documentationOf.serviceEvent
Short | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.
Comments | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
Invariants | should-us-performer: SHOULD contain performer (`performer.exists()`) should-code: SHOULD contain code (`code.exists()`) should-performer: SHOULD contain performer (`performer.exists()`)
2266. ClinicalDocument.documentationOf.serviceEvent.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2268. ClinicalDocument.documentationOf.serviceEvent.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
2270. ClinicalDocument.documentationOf.serviceEvent.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2272. ClinicalDocument.documentationOf.serviceEvent.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2274. ClinicalDocument.documentationOf.serviceEvent.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2276. ClinicalDocument.documentationOf.serviceEvent.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2278. ClinicalDocument.documentationOf.serviceEvent.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2280. ClinicalDocument.documentationOf.serviceEvent.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2282. 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
2284. ClinicalDocument.documentationOf.serviceEvent.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2286. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2288. ClinicalDocument.documentationOf.serviceEvent.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2290. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Short | The code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.
Comments | This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2292. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
2294. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2296. 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.
Short | Either @value or low/high should be present, but not both
Control | 0..1
Type | dateTime(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.
2298. 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 CDASetOperator (required to `http://hl7.org/cda/stds/core/ValueSet/CDASetOperator` )
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`
2300. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Short | **MAY** be precise to at least the second
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
Invariants | ts-shall-day: **SHALL** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`) ts-should-minute: **SHOULD** be precise to at least the minute (`nullFlavor.exists() or value.toString().length() > 10`)
2302. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2304. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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 | dateTime(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.
2306. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive
Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).
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.
Default Value | `true`
2308. 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
2310. 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
2312. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Short | **MAY** be precise to at least the second
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
Invariants | ts-shall-day: **SHALL** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`) ts-should-minute: **SHOULD** be precise to at least the minute (`nullFlavor.exists() or value.toString().length() > 10`)
2314. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2316. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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 | dateTime(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.
2318. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive
Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).
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.
Default Value | `true`
2320. ClinicalDocument.documentationOf.serviceEvent.performer
Short | SHOULD contain performer
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713).
Control | 0..* This element is affected by the following invariants: should-us-performer, should-performer
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
2322. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2324. 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
2326. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2328. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2330. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2332. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2334. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2336. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2338. 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
2340. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601` )
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.
2342. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Short | When indicating the performer was the primary care physician, implementers should indicate "PCP" as the 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
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
2344. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2346. 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 SHALL be taken from ParticipationFunction (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267` )
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
2348. 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
2350. 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
2352. 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
2354. 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
2356. 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`.
2358. 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`.
2360. 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
2362. 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
2364. 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
2366. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
2368. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-us-code: SHOULD contain code (`code.exists()`)
2370. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2372. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2374. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2376. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2378. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2380. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2382. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2384. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2386. 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
2388. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
2390. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Short | The combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2392. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2394. 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
2396. 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
2398. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
2400. 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
2402. ClinicalDocument.documentationOf.serviceEvent.performer.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`.
2404. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Short | If the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set
Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2406. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcSpecialty
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`specialty`.
2408. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
2410. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
2412. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
2414. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2416. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
2418. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
2420. ClinicalDocument.relatedDocument
Short | Source of a document revision, addenda, or transformation
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
Requirements | A conformant CDA document can have a single relatedDocument with typeCode 'APND'; a single relatedDocument with typeCode 'RPLC'; a single relatedDocument with typeCode 'XFRM'; a combination of two relatedDocuments with typeCodes 'XFRM' and 'RPLC'; or a combination of two relatedDocuments with typeCodes 'XFRM' and 'APND'. No other combinations are allowed.
2422. ClinicalDocument.authorization
Short | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document.
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
2424. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2426. 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
2428. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2430. ClinicalDocument.authorization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2432. ClinicalDocument.authorization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2434. ClinicalDocument.authorization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2436. ClinicalDocument.authorization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2438. ClinicalDocument.authorization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2440. 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
2442. ClinicalDocument.authorization.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipAuthorizedBy (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy|3.0.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.
Fixed Value | `AUTH`
2444. 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
2446. ClinicalDocument.authorization.consent.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2448. ClinicalDocument.authorization.consent.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
2450. ClinicalDocument.authorization.consent.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2452. ClinicalDocument.authorization.consent.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2454. ClinicalDocument.authorization.consent.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2456. ClinicalDocument.authorization.consent.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2458. ClinicalDocument.authorization.consent.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2460. ClinicalDocument.authorization.consent.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2462. 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
2464. ClinicalDocument.authorization.consent.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2466. ClinicalDocument.authorization.consent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2468. ClinicalDocument.authorization.consent.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794). Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
2470. 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 | For example codes, see ActCode (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2472. 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 (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
2474. ClinicalDocument.authorization.consent.statusCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2476. ClinicalDocument.authorization.consent.statusCode.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: 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.
Label | Code
Fixed Value | `completed`
2478. ClinicalDocument.authorization.consent.statusCode.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
2480. ClinicalDocument.authorization.consent.statusCode.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
2482. ClinicalDocument.authorization.consent.statusCode.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
2484. ClinicalDocument.authorization.consent.statusCode.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
2486. ClinicalDocument.authorization.consent.statusCode.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
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`.
2488. ClinicalDocument.authorization.consent.statusCode.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
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`.
2490. ClinicalDocument.authorization.consent.statusCode.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
2492. ClinicalDocument.authorization.consent.statusCode.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
2494. ClinicalDocument.authorization.consent.statusCode.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
2496. ClinicalDocument.componentOf
Definition | This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.
Short | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.
Comments | MAY contain zero or one [0..1] componentOf (CONF:4537-9955).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
2498. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2500. 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
2502. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2504. ClinicalDocument.componentOf.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2506. ClinicalDocument.componentOf.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2508. ClinicalDocument.componentOf.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2510. ClinicalDocument.componentOf.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2512. ClinicalDocument.componentOf.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2514. 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
2516. ClinicalDocument.componentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent|3.0.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.
Fixed Value | `COMP`
2518. 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
Invariants | should-responsibleParty: SHOULD contain responsibleParty (`responsibleParty.exists()`)
2520. ClinicalDocument.componentOf.encompassingEncounter.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2522. ClinicalDocument.componentOf.encompassingEncounter.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
2524. ClinicalDocument.componentOf.encompassingEncounter.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2526. ClinicalDocument.componentOf.encompassingEncounter.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2528. ClinicalDocument.componentOf.encompassingEncounter.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2530. ClinicalDocument.componentOf.encompassingEncounter.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2532. ClinicalDocument.componentOf.encompassingEncounter.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2534. ClinicalDocument.componentOf.encompassingEncounter.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2536. 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
2538. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2540. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2542. 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
2544. ClinicalDocument.componentOf.encompassingEncounter.code
Comments | This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873).
Control | 0..1
Binding | The codes SHOULD be taken from Act Encounter Codes (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2546. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments | This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
2548. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
Definition | This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.
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`.
2550. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control | 0..1
Binding | For example codes, see USEncounterDischargeDisposition (5.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition|5.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2552. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Definition | The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.
Comments | This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2554. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2556. 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
2558. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2560. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2562. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2564. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2566. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2568. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2570. 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
2572. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
2574. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Comments | The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (`assignedPerson.exists() or representedOrganization.exists()`)
2576. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
2578. 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). The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow. When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2580. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2582. 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
2584. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2586. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2588. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2590. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2592. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2594. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2596. 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
2598. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetLocation (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation|3.0.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.
Fixed Value | `LOC`
2600. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
2602. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2604. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2606. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2608. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2610. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2612. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2614. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2616. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2618. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2620. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassServiceDeliveryLocation (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassServiceDeliveryLocation|3.0.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.
Default Value | `SDLOC`
2622. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2624. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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`.
2626. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.code
Control | 0..1
Binding | For example codes, see ServiceDeliveryLocationRoleType (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2628. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Place
2630. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2632. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2634. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2636. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2638. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2640. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2642. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2644. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2646. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2648. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassPlace|3.0.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.
Fixed Value | `PLC`
2650. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
2652. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
2654. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.addr
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Address
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
2656. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.serviceProviderOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2658. ClinicalDocument.component
Short | Body of the document
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component
2660. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2662. 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
2664. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2666. ClinicalDocument.component.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2668. ClinicalDocument.component.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2670. ClinicalDocument.component.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2672. ClinicalDocument.component.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2674. ClinicalDocument.component.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2676. 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
2678. ClinicalDocument.component.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent|3.0.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.
Fixed Value | `COMP`
2680. 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`
2682. ClinicalDocument.component.nonXMLBody
Short | A body in some format other than XML.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody
2684. ClinicalDocument.component.structuredBody
Short | A body comprised of one or more document sections.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
2686. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2688. 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
2690. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2692. ClinicalDocument.component.structuredBody.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2694. ClinicalDocument.component.structuredBody.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2696. ClinicalDocument.component.structuredBody.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2698. ClinicalDocument.component.structuredBody.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2700. ClinicalDocument.component.structuredBody.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2702. 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
2704. ClinicalDocument.component.structuredBody.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClassRecordOrganizer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer|3.0.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.
Fixed Value | `DOCBODY`
2706. ClinicalDocument.component.structuredBody.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2708. ClinicalDocument.component.structuredBody.confidentialityCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2710. ClinicalDocument.component.structuredBody.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
2712. ClinicalDocument.component.structuredBody.component
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
Slicing | This element introduces a set of slices on `ClinicalDocument.component.structuredBody.component`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ section
2714. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2716. 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
2718. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2720. ClinicalDocument.component.structuredBody.component.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2722. ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2724. ClinicalDocument.component.structuredBody.component.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2726. ClinicalDocument.component.structuredBody.component.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2728. ClinicalDocument.component.structuredBody.component.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2730. 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
2732. 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`
2734. 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`
2736. ClinicalDocument.component.structuredBody.component.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2738. ClinicalDocument.component.structuredBody.component:source-form
Slice Name | source-form
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2740. ClinicalDocument.component.structuredBody.component:source-form.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2742. ClinicalDocument.component.structuredBody.component:source-form.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
2744. ClinicalDocument.component.structuredBody.component:source-form.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2746. ClinicalDocument.component.structuredBody.component:source-form.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2748. ClinicalDocument.component.structuredBody.component:source-form.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2750. ClinicalDocument.component.structuredBody.component:source-form.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2752. ClinicalDocument.component.structuredBody.component:source-form.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2754. ClinicalDocument.component.structuredBody.component:source-form.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2756. ClinicalDocument.component.structuredBody.component:source-form.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
2758. ClinicalDocument.component.structuredBody.component:source-form.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`
2760. ClinicalDocument.component.structuredBody.component:source-form.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`
2762. ClinicalDocument.component.structuredBody.component:source-form.section
Short | Person's signature and Information about Witnesses or Notary required to complete a valid document
Comments | SHOULD contain 0..* Esignature ObservationMedia Entry where the id references the associated authenticator in the header.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Witness And Notary Section)
2764. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment
Slice Name | healthcare-agent-appointment
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2766. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2768. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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
2770. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2772. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2774. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2776. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2778. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2780. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2782. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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
2784. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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`
2786. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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`
2788. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.section
Short | Consent information that appoints healthcare agents
Comments | SHOULD contain 0..1 Healthcare Agent Consent Entry. This entry includes options for expressing why no healthcare agent(s) were appointed.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Healthcare Agent Appointment Section)
2790. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences
Slice Name | treatment-intervention-preferences
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2792. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2794. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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
2796. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2798. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2800. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2802. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2804. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2806. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2808. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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
2810. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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`
2812. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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`
2814. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.section
Short | Persion's conditional treatment intervention preferences
Comments | SHOULD contain 0..* Treatment Intervention Preference Entry
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Treatment Intervention Preferences Section)
2816. ClinicalDocument.component.structuredBody.component:care-experience-preferences
Slice Name | care-experience-preferences
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2818. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2820. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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
2822. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2824. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2826. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2828. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2830. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2832. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2834. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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
2836. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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`
2838. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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`
2840. ClinicalDocument.component.structuredBody.component:care-experience-preferences.section
Short | Person's conditional care experience preferences
Comments | SHOULD contain 0..* Care Experience Preference Entry.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Care Experience Preferences Section)
2842. ClinicalDocument.component.structuredBody.component:upon-death-preferences
Slice Name | upon-death-preferences
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2844. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2846. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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
2848. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2850. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2852. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2854. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2856. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2858. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2860. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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
2862. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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`
2864. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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`
2866. ClinicalDocument.component.structuredBody.component:upon-death-preferences.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2868. ClinicalDocument.component.structuredBody.component:additional-documentation
Slice Name | additional-documentation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2870. ClinicalDocument.component.structuredBody.component:additional-documentation.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2872. ClinicalDocument.component.structuredBody.component:additional-documentation.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
2874. ClinicalDocument.component.structuredBody.component:additional-documentation.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2876. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2878. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2880. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2882. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2884. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2886. ClinicalDocument.component.structuredBody.component:additional-documentation.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
2888. ClinicalDocument.component.structuredBody.component:additional-documentation.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`
2890. ClinicalDocument.component.structuredBody.component:additional-documentation.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`
2892. ClinicalDocument.component.structuredBody.component:additional-documentation.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2894. ClinicalDocument.component.structuredBody.component:administrative-information
Slice Name | administrative-information
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2896. ClinicalDocument.component.structuredBody.component:administrative-information.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2898. ClinicalDocument.component.structuredBody.component:administrative-information.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
2900. ClinicalDocument.component.structuredBody.component:administrative-information.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2902. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2904. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2906. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2908. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2910. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2912. ClinicalDocument.component.structuredBody.component:administrative-information.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
2914. ClinicalDocument.component.structuredBody.component:administrative-information.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`
2916. ClinicalDocument.component.structuredBody.component:administrative-information.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`
2918. ClinicalDocument.component.structuredBody.component:administrative-information.section
Short | Information collected for administrative reasons
Comments | SHOULD contain 0..* Advance Healthcare Directive Observation Entry.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Administrative Information Section)
2920. ClinicalDocument.component.structuredBody.component:completion-information
Slice Name | completion-information
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2922. ClinicalDocument.component.structuredBody.component:completion-information.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2924. ClinicalDocument.component.structuredBody.component:completion-information.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
2926. ClinicalDocument.component.structuredBody.component:completion-information.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2928. ClinicalDocument.component.structuredBody.component:completion-information.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2930. ClinicalDocument.component.structuredBody.component:completion-information.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2932. ClinicalDocument.component.structuredBody.component:completion-information.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2934. ClinicalDocument.component.structuredBody.component:completion-information.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2936. ClinicalDocument.component.structuredBody.component:completion-information.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2938. ClinicalDocument.component.structuredBody.component:completion-information.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
2940. ClinicalDocument.component.structuredBody.component:completion-information.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`
2942. ClinicalDocument.component.structuredBody.component:completion-information.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`
2944. ClinicalDocument.component.structuredBody.component:completion-information.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2946. ClinicalDocument.component.structuredBody.component:witness-and-notary
Slice Name | witness-and-notary
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2948. ClinicalDocument.component.structuredBody.component:witness-and-notary.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2950. ClinicalDocument.component.structuredBody.component:witness-and-notary.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
2952. ClinicalDocument.component.structuredBody.component:witness-and-notary.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2954. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2956. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2958. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2960. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2962. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2964. ClinicalDocument.component.structuredBody.component:witness-and-notary.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
2966. ClinicalDocument.component.structuredBody.component:witness-and-notary.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`
2968. ClinicalDocument.component.structuredBody.component:witness-and-notary.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`
2970. ClinicalDocument.component.structuredBody.component:witness-and-notary.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section

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

0. ClinicalDocument
Logical Container | ClinicalDocument (CDA Class)
Validation | Instance of this type are validated by templateId
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. ClinicalDocument.templateId
Control | 3..?
4. ClinicalDocument.templateId:personal-acp
Slice Name | personal-acp
Control | 1..1
6. ClinicalDocument.templateId:personal-acp.root
Control | 1..?
Pattern Value | `2.16.840.1.113883.4.823.1.1.1`
8. ClinicalDocument.templateId:personal-acp.extension
Control | 1..?
Pattern Value | `2026-08-28`
10. ClinicalDocument.id
Comments | This is the master identifier in a DocumentReference document indexing resource.
12. ClinicalDocument.sdtcCategory
Control | 1..?
Must Support | true
Slicing | This element introduces a set of slices on `ClinicalDocument.sdtcCategory`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ code value @ codeSystem
14. ClinicalDocument.sdtcCategory:ahdDocumentClass
Slice Name | ahdDocumentClass
Control | 1..1
16. ClinicalDocument.sdtcCategory:ahdDocumentClass.code
Short | Used to categorize the document type as an Advance Healthcare Directive
Control | 1..?
Pattern Value | `42348-3`
18. ClinicalDocument.sdtcCategory:ahdDocumentClass.codeSystem
Control | 1..?
Pattern Value | `2.16.840.1.113883.6.1`
20. ClinicalDocument.sdtcCategory:ahdDocumentClass.codeSystemName
Control | 1..?
Pattern Value | `LOINC`
22. ClinicalDocument.sdtcCategory:ahdDocumentClass.displayName
Control | 1..?
24. ClinicalDocument.sdtcCategory:pacpDocumentClass
Slice Name | pacpDocumentClass
Control | 0..1
Must Support | true
26. ClinicalDocument.sdtcCategory:pacpDocumentClass.code
Short | Used to categorize the document type as a Patient-Authored Consent Document
Control | 1..?
Pattern Value | `59284-0`
28. ClinicalDocument.sdtcCategory:pacpDocumentClass.codeSystem
Control | 1..?
Pattern Value | `2.16.840.1.113883.6.1`
30. ClinicalDocument.sdtcCategory:pacpDocumentClass.codeSystemName
Control | 1..?
Pattern Value | `LOINC`
32. ClinicalDocument.sdtcCategory:pacpDocumentClass.displayName
Control | 1..?
34. ClinicalDocument.code
Short | This profile is used to represent a person-authored advance healthcare directive document. A person authored advance healthcare directive document is categorized as a consent document. This sub-category of advance healthcare directive documents expresses the patient’s own preferences as opposed to provider-authored advance healthcare directive documents which establish portable medical orders for the patient. This sub-category of advance healthcare directive document always is authored by the subject of the document (the patient). If care providers are involved in the creation of these types of documents, they may be included as facilitators. The patient (or their representative) is required to sign the document and is represented as an authenticator. Others who sign the document are represented as authenticators with their role such as witness or notary also included. It includes a presentation of the original source form of the completed document. It includes information about the person’s appointed healthcare agent(s), and may additionally include treatment intervention and care experience preferences under potential future health scenarios, administrative and completion information, additional documentation, and witness and notary information. The document always contains the source form in the Source Form section. It may include textual information present in the source form, organized in standard structural sections which may or may not include machine processable encoded entries.
Comments | SHALL contain exactly one [1..1] code.
Binding | The codes SHALL be taken from Advance Directive Document Types (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.22` )
36. ClinicalDocument.sdtcStatusCode
Comments | sdtc:statusCode is #completed is for documents where all activities required for a valid document have been completed, #new is for new documents or document versions that have not been completed yet.
Control | 1..?
38. ClinicalDocument.effectiveTime
Short | The system origination time
Comments | Use miliseconds and the relevant timezone offset from UTC to explicitly state the timezone of the document's author and to support federated document management.
40. ClinicalDocument.setId
Short | Identifier a single logical document
Comments | Identifies all versions of a single logical document
Control | 1..?
42. ClinicalDocument.versionNumber
Short | The distinct version of a logical document
Comments | Used in conjunction with setId to identify a distinct version of a logical document
Control | 1..?
44. ClinicalDocument.component
46. ClinicalDocument.component.structuredBody
48. ClinicalDocument.component.structuredBody.component
Must Support | true
Slicing | This element introduces a set of slices on `ClinicalDocument.component.structuredBody.component`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ section
50. ClinicalDocument.component.structuredBody.component:source-form
Slice Name | source-form
Control | 1..1
Must Support | true
52. ClinicalDocument.component.structuredBody.component:source-form.section
Short | Person's signature and Information about Witnesses or Notary required to complete a valid document
Comments | SHOULD contain 0..* Esignature ObservationMedia Entry where the id references the associated authenticator in the header.
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Witness And Notary Section)
54. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment
Slice Name | healthcare-agent-appointment
Control | 0..1
Must Support | true
56. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.section
Short | Consent information that appoints healthcare agents
Comments | SHOULD contain 0..1 Healthcare Agent Consent Entry. This entry includes options for expressing why no healthcare agent(s) were appointed.
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Healthcare Agent Appointment Section)
58. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences
Slice Name | treatment-intervention-preferences
Control | 0..1
Must Support | true
60. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.section
Short | Persion's conditional treatment intervention preferences
Comments | SHOULD contain 0..* Treatment Intervention Preference Entry
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Treatment Intervention Preferences Section)
62. ClinicalDocument.component.structuredBody.component:care-experience-preferences
Slice Name | care-experience-preferences
Control | 0..1
Must Support | true
64. ClinicalDocument.component.structuredBody.component:care-experience-preferences.section
Short | Person's conditional care experience preferences
Comments | SHOULD contain 0..* Care Experience Preference Entry.
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Care Experience Preferences Section)
66. ClinicalDocument.component.structuredBody.component:upon-death-preferences
Slice Name | upon-death-preferences
Control | 0..1
Must Support | true
68. ClinicalDocument.component.structuredBody.component:additional-documentation
Slice Name | additional-documentation
Control | 0..1
Must Support | true
70. ClinicalDocument.component.structuredBody.component:administrative-information
Slice Name | administrative-information
Control | 0..1
Must Support | true
72. ClinicalDocument.component.structuredBody.component:administrative-information.section
Short | Information collected for administrative reasons
Comments | SHOULD contain 0..* Advance Healthcare Directive Observation Entry.
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Administrative Information Section)
74. ClinicalDocument.component.structuredBody.component:completion-information
Slice Name | completion-information
Control | 0..1
Must Support | true
76. ClinicalDocument.component.structuredBody.component:witness-and-notary
Slice Name | witness-and-notary
Control | 0..1
Must Support | true

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

0. ClinicalDocument
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
Logical Container | ClinicalDocument (CDA Class)
Validation | Instance of this type are validated by templateId
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (`setId.exists() implies versionNumber.exists()`) 4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). (`versionNumber.exists() implies setId.exists()`) should-legalAuthenticator: SHOULD contain legalAuthenticator (`legalAuthenticator.exists()`) should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant (`participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()`)
2. ClinicalDocument.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
4. ClinicalDocument.classCode
Control | 0..1
Binding | For example codes, see CDAActClass (example to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
6. ClinicalDocument.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
8. 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
10. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
12. 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`
14. 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
16. 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
18. 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
20. 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
22. 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`.
24. 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`.
26. 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
28. 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
30. 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
32. ClinicalDocument.typeId
Definition | ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).
Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
34. ClinicalDocument.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
36. ClinicalDocument.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
38. ClinicalDocument.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
40. ClinicalDocument.typeId.root
Definition | Identifies the type as an HL7 Registered model
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(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
Fixed Value | `2.16.840.1.113883.1.3`
42. ClinicalDocument.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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.
Label | Extension
Fixed Value | `POCD_HD000040`
44. 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 | 3..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ClinicalDocument.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
46. 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
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
48. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
50. 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
52. 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
54. 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.
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`
56. ClinicalDocument.templateId:us-realm.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | `2024-05-01`
58. ClinicalDocument.templateId:us-patient-gen-doc
Slice Name | us-patient-gen-doc
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 | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
60. ClinicalDocument.templateId:us-patient-gen-doc.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
62. ClinicalDocument.templateId:us-patient-gen-doc.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
64. ClinicalDocument.templateId:us-patient-gen-doc.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
66. ClinicalDocument.templateId:us-patient-gen-doc.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
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.29.1`
68. ClinicalDocument.templateId:us-patient-gen-doc.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | `2024-05-01`
70. ClinicalDocument.templateId:personal-acp
Slice Name | personal-acp
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 | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
72. ClinicalDocument.templateId:personal-acp.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
74. ClinicalDocument.templateId:personal-acp.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
76. ClinicalDocument.templateId:personal-acp.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
78. ClinicalDocument.templateId:personal-acp.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
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.823.1.1.1`
80. ClinicalDocument.templateId:personal-acp.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | `2026-08-28`
82. ClinicalDocument.id
Definition | Represents the unique instance identifier of a clinical document.
Short | **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
Comments | This is the master identifier in a DocumentReference document indexing resource.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
84. ClinicalDocument.sdtcCategory
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Must Support | true
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`category`.
Slicing | This element introduces a set of slices on `ClinicalDocument.sdtcCategory`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ code value @ codeSystem
86. ClinicalDocument.sdtcCategory:ahdDocumentClass
Slice Name | ahdDocumentClass
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
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`category`.
88. ClinicalDocument.sdtcCategory:ahdDocumentClass.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
90. ClinicalDocument.sdtcCategory:ahdDocumentClass.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.
Short | Used to categorize the document type as an Advance Healthcare Directive
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 | `42348-3`
92. ClinicalDocument.sdtcCategory:ahdDocumentClass.codeSystem
Definition | Specifies the code system that defines the code.
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`
94. ClinicalDocument.sdtcCategory:ahdDocumentClass.codeSystemName
Definition | The common name of the coding system.
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 | Code System Name
Pattern Value | `LOINC`
96. ClinicalDocument.sdtcCategory:ahdDocumentClass.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
98. ClinicalDocument.sdtcCategory:ahdDocumentClass.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
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 | Display Name
100. ClinicalDocument.sdtcCategory:ahdDocumentClass.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`.
102. ClinicalDocument.sdtcCategory:ahdDocumentClass.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`.
104. ClinicalDocument.sdtcCategory:ahdDocumentClass.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
106. ClinicalDocument.sdtcCategory:ahdDocumentClass.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
108. ClinicalDocument.sdtcCategory:ahdDocumentClass.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
110. ClinicalDocument.sdtcCategory:pacpDocumentClass
Slice Name | pacpDocumentClass
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Must Support | true
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`category`.
112. ClinicalDocument.sdtcCategory:pacpDocumentClass.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
114. ClinicalDocument.sdtcCategory:pacpDocumentClass.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.
Short | Used to categorize the document type as a Patient-Authored Consent Document
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 | `59284-0`
116. ClinicalDocument.sdtcCategory:pacpDocumentClass.codeSystem
Definition | Specifies the code system that defines the code.
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`
118. ClinicalDocument.sdtcCategory:pacpDocumentClass.codeSystemName
Definition | The common name of the coding system.
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 | Code System Name
Pattern Value | `LOINC`
120. ClinicalDocument.sdtcCategory:pacpDocumentClass.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
122. ClinicalDocument.sdtcCategory:pacpDocumentClass.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
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 | Display Name
124. ClinicalDocument.sdtcCategory:pacpDocumentClass.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`.
126. ClinicalDocument.sdtcCategory:pacpDocumentClass.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`.
128. ClinicalDocument.sdtcCategory:pacpDocumentClass.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
130. ClinicalDocument.sdtcCategory:pacpDocumentClass.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
132. ClinicalDocument.sdtcCategory:pacpDocumentClass.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
134. ClinicalDocument.code
Definition | The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).
Short | This profile is used to represent a person-authored advance healthcare directive document. A person authored advance healthcare directive document is categorized as a consent document. This sub-category of advance healthcare directive documents expresses the patient’s own preferences as opposed to provider-authored advance healthcare directive documents which establish portable medical orders for the patient. This sub-category of advance healthcare directive document always is authored by the subject of the document (the patient). If care providers are involved in the creation of these types of documents, they may be included as facilitators. The patient (or their representative) is required to sign the document and is represented as an authenticator. Others who sign the document are represented as authenticators with their role such as witness or notary also included. It includes a presentation of the original source form of the completed document. It includes information about the person’s appointed healthcare agent(s), and may additionally include treatment intervention and care experience preferences under potential future health scenarios, administrative and completion information, additional documentation, and witness and notary information. The document always contains the source form in the Source Form section. It may include textual information present in the source form, organized in standard structural sections which may or may not include machine processable encoded entries.
Comments | SHALL contain exactly one [1..1] code.
Control | 1..1
Binding | The codes SHALL be taken from Advance Directive Document Types (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.22` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
136. 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..0
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
138. 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.
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
140. ClinicalDocument.code.codeSystem
Definition | Specifies the code system that defines the code.
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`
142. 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
144. 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
146. 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
148. 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`.
150. 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`.
152. 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
154. 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
156. 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
158. 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
160. ClinicalDocument.sdtcStatusCode
Definition | The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.
Comments | sdtc:statusCode is #completed is for documents where all activities required for a valid document have been completed, #new is for new documents or document versions that have not been completed yet.
Control | 1..1
Binding | The codes SHALL be taken from ActStatus (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
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`statusCode`.
162. ClinicalDocument.effectiveTime
Definition | Signifies the document creation time, when the document first came into being.
Short | The system origination time
Comments | Use miliseconds and the relevant timezone offset from UTC to explicitly state the timezone of the document's author and to support federated document management.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
164. ClinicalDocument.confidentialityCode
Short | Controls the disclosure of information in this document
Comments | Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
166. ClinicalDocument.confidentialityCode.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..0
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
168. ClinicalDocument.confidentialityCode.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
Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926` )
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
170. ClinicalDocument.confidentialityCode.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
172. ClinicalDocument.confidentialityCode.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
174. ClinicalDocument.confidentialityCode.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
176. ClinicalDocument.confidentialityCode.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
178. ClinicalDocument.confidentialityCode.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`.
180. ClinicalDocument.confidentialityCode.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`.
182. ClinicalDocument.confidentialityCode.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
184. ClinicalDocument.confidentialityCode.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
186. ClinicalDocument.confidentialityCode.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
188. ClinicalDocument.languageCode
Definition | Specifies the human language of character data (whether they be in contents or attribute values).
Short | Human language of character data
Comments | SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.
Control | 1..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
190. ClinicalDocument.setId
Short | Identifier a single logical document
Comments | Identifies all versions of a single logical document
Control | 1..1 This element is affected by the following invariants: 4537-6380, 4537-6387
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
192. ClinicalDocument.versionNumber
Short | The distinct version of a logical document
Comments | Used in conjunction with setId to identify a distinct version of a logical document
Control | 1..1 This element is affected by the following invariants: 4537-6380, 4537-6387
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
194. ClinicalDocument.copyTime
Definition | Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.
Short | Deprecated - use is discouraged
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Requirements | Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.
196. ClinicalDocument.recordTarget
Short | The recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. If the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA. HL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded.
Comments | SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
Requirements | The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.
198. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
200. 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
202. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
204. ClinicalDocument.recordTarget.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
206. ClinicalDocument.recordTarget.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
208. ClinicalDocument.recordTarget.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
210. ClinicalDocument.recordTarget.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
212. ClinicalDocument.recordTarget.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
214. 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
216. ClinicalDocument.recordTarget.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
218. ClinicalDocument.recordTarget.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
220. ClinicalDocument.recordTarget.patientRole
Comments | This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
222. ClinicalDocument.recordTarget.patientRole.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
224. ClinicalDocument.recordTarget.patientRole.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
226. ClinicalDocument.recordTarget.patientRole.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
228. ClinicalDocument.recordTarget.patientRole.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
230. ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
232. ClinicalDocument.recordTarget.patientRole.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
234. ClinicalDocument.recordTarget.patientRole.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
236. ClinicalDocument.recordTarget.patientRole.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
238. 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
240. ClinicalDocument.recordTarget.patientRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassRelationshipFormal (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal|3.0.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.
Fixed Value | `PAT`
242. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
244. 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`.
246. ClinicalDocument.recordTarget.patientRole.addr
Short | 𝗨𝗦𝗖𝗗𝗜: Address
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)
248. ClinicalDocument.recordTarget.patientRole.telecom
Short | 𝗨𝗦𝗖𝗗𝗜: Phone Number / Email
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
250. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
252. 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.
254. 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
256. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
258. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (`sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()`) 4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true (`sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')`) should-maritalStatusCode: SHOULD contain maritalStatusCode (`maritalStatusCode.exists()`) should-us-languageCommunication: SHOULD contain languageCommunication (`languageCommunication.exists()`) should-languageCommunication: SHOULD contain languageCommunication (`languageCommunication.exists()`)
260. ClinicalDocument.recordTarget.patientRole.patient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
262. ClinicalDocument.recordTarget.patientRole.patient.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
264. ClinicalDocument.recordTarget.patientRole.patient.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
266. ClinicalDocument.recordTarget.patientRole.patient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
268. ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
270. ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
272. ClinicalDocument.recordTarget.patientRole.patient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
274. ClinicalDocument.recordTarget.patientRole.patient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
276. 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
278. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
280. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
282. ClinicalDocument.recordTarget.patientRole.patient.id
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
284. ClinicalDocument.recordTarget.patientRole.patient.name
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))
286. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
288. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Control | 0..1
Binding | For example codes, see AdministrativeGender (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
290. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Short | 𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)
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 | ts-shall-year: **SHALL** be precise to at least the year (`nullFlavor.exists() or value.toString().length() >= 4`) ts-should-day: **SHOULD** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`)
292. 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`.
294. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | 𝗨𝗦𝗖𝗗𝗜: Date of Death
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`.
Invariants | should-value-att: SHOULD contain @value (`value.exists()`) ts-shall-year: **SHALL** be precise to at least the year (`nullFlavor.exists() or value.toString().length() >= 4`) ts-should-day: **SHOULD** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`)
296. 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`.
298. 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`.
300. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
Short | SHOULD contain 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 This element is affected by the following invariants: should-maritalStatusCode
Binding | The codes SHALL be taken from Marital Status (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
302. 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 (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
304. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Short | 𝗨𝗦𝗖𝗗𝗜: Race - raceCode SHALL contain only the OMB race category; detailed race values go in translation. Additional race categories are conveyed using sdtc:raceCode, following the same pattern (OMB category in root; details in translation).
Control | 1..1
Binding | The codes SHALL be taken from Race Categories (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.2.575` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
306. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
308. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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 | 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.
Label | Code
310. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
312. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
314. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
316. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
318. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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`.
320. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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`.
322. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
324. ClinicalDocument.recordTarget.patientRole.patient.raceCode.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
326. ClinicalDocument.recordTarget.patientRole.patient.raceCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Binding | The codes SHOULD be taken from Race Value Set (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914` )
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
Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. (`(code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()`)
328. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short | 𝗨𝗦𝗖𝗗𝗜: Race - 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.
Control | 0..*
Binding | The codes SHALL be taken from Detailed race including absence reasons. (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.25` )
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 | sdtc-race-not-detail: When using translation to convey race details, the base code SHALL be a race category. (`translation.exists(codeSystem = '2.16.840.1.113883.6.238') implies (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1'))`)
330. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
332. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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 | 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.
Label | Code
334. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
336. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
338. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
340. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
342. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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`.
344. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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`.
346. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
348. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.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
350. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Binding | The codes SHOULD be taken from Race Value Set (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914` )
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
Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. (`(code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()`)
352. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity
Control | 1..1
Binding | The codes SHALL be taken from Ethnicity Categories (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.3` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
354. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity
Control | 0..*
Binding | The codes SHALL be taken from Detailed Ethnicity Including Absence Reasons (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.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`ethnicGroupCode`.
356. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments | This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
Invariants | should-us-code: SHOULD contain code (`code.exists()`) should-us-addr: SHOULD contain addr (`addr.exists()`) should-us-telecom: SHOULD contain telecom (`telecom.exists()`) should-id: SHOULD contain id (`id.exists()`) should-code: SHOULD contain code (`code.exists()`)
358. ClinicalDocument.recordTarget.patientRole.patient.guardian.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
360. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
362. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
364. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
366. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
368. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
370. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
372. ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
374. 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
376. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAgent (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent|3.0.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.
Fixed Value | `GUARD`
378. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Comments | The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
380. 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`.
382. 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:1198-28473).
Control | 0..1
Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
384. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
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)
386. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
388. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
390. 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.
392. 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
394. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
396. 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
398. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
400. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
402. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
404. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
406. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
408. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
410. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
412. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
414. 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
416. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
418. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
420. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
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))
422. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
424. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
426. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
428. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
430. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
432. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
434. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
436. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
438. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
440. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
442. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
444. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
446. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
448. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
450. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
452. 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
454. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
456. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
458. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
460. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
462. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
464. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
466. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
468. ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
470. 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
472. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassPassive (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassPassive|3.0.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.
Fixed Value | `BIRTHPL`
474. 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
476. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
478. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
480. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
482. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
484. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
486. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
488. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
490. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
492. 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
494. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassPlace|3.0.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.
Fixed Value | `PLC`
496. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
498. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
500. 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 US Core USPS State *DYNAMIC* (CONF:4537-5402). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://terminology.hl7.org/ValueSet/USPS-State'))`) 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). (`nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))`) should-country: SHOULD contain country (`nullFlavor.exists() or item.country.exists()`)
502. 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.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
504. 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
506. 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..*
Binding | The codes SHALL be taken from CDAPostalAddressUse (required to `http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse` )
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
508. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
Definition | A series of items that constitute the address.
Control | 0..*
Type | http://hl7.org/fhir/StructureDefinition/Base
Choice Group | This is a repeating choice group that does not appear directly in the instance
Invariants | AD-1: Can only have only one of the possible item elements in each choice (`(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1`)
510. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter
Definition | Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
512. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
514. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
516. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
518. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
520. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
522. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
524. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
Definition | Country
Control | 0..1
Binding | The codes SHALL be taken from Country2 (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-Country2|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
526. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
528. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
530. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
532. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
534. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
536. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
538. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state
Definition | A sub-unit of a country with limited sovereignty in a federally organized country.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
540. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
544. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
546. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
548. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
550. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
552. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
554. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
556. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
558. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
560. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
562. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
564. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
566. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city
Definition | The name of the city, town, village, or other community or delivery center
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
568. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
570. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
572. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
574. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
576. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
578. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
580. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
582. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
584. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
586. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
588. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
590. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
592. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
594. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine
Definition | Street address line
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
596. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
598. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
600. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
602. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
604. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
606. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
608. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
610. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
612. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
614. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
616. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
618. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
620. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
622. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric
Definition | The numeric portion of a building number
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
624. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
626. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
628. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
630. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
632. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
634. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
636. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction
Definition | Direction (e.g., N, S, W, E)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
638. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
640. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
642. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
644. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
646. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
648. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
650. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName
Definition | Name of a roadway or artery recognized by a municipality (including street type and direction)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
652. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
654. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
656. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
658. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
660. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
662. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
664. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
666. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
668. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
670. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
672. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
674. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
676. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
678. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
680. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
682. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
684. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
686. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
688. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
690. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
692. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
694. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
696. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
698. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
700. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
702. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
704. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
706. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
708. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
710. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
712. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
714. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
716. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
718. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
720. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType
Definition | Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
722. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
724. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
726. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
728. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
730. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
732. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
734. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
736. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
738. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
740. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
742. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
744. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
746. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
748. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract
Definition | A geographic sub-unit delineated for demographic purposes.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
750. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
752. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
754. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
756. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
758. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
760. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
762. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
764. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
768. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
770. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
772. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
774. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
776. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
778. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
780. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
782. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
784. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
786. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
788. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
790. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
792. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
794. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
796. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
798. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
800. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
802. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
804. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
806. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
808. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
810. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
812. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
814. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
816. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
818. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode
Definition | Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
820. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
822. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
824. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
826. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
828. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
830. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
832. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
834. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
836. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
838. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
840. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
842. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
844. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
846. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix
Definition | Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
848. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
850. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
852. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
854. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
856. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
858. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
860. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox
Definition | A numbered box located in a post station.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
862. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
864. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
866. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
868. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
870. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
872. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
874. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct
Definition | A subsection of a municipality
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariants | text-null: xmlText and nullFlavor are mutually exclusive (one must be present) (`(xmlText | nullFlavor).count() = 1`)
876. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
878. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation
Definition | Specifies the representation of the binary data that is the content of the binary data value
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 | `TXT`
880. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
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.
Label | Media Type
Fixed Value | `text/plain`
882. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language
Definition | For character based information the language property specifies the human language of the text.
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.
Label | Language
884. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
886. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.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`
888. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText
Short | Allows for mixed text content
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
890. 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
892. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Short | 𝗨𝗦𝗖𝗗𝗜: Preferred Language
Comments | This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (`proficiencyLevelCode.exists()`) should-preferenceInd: SHOULD contain preferenceInd (`preferenceInd.exists()`)
894. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
896. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
898. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
900. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
902. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
904. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
906. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
908. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
910. 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
912. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Control | 1..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
914. 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 (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
916. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
Short | SHOULD contain 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 This element is affected by the following invariants: should-proficiencyLevelCode
Binding | The codes SHALL be taken from LanguageAbilityProficiency (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
918. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Short | Indicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language. If more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.
Comments | The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:1198-28475).
Control | 0..1 This element is affected by the following invariants: should-preferenceInd
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
920. ClinicalDocument.recordTarget.patientRole.providerOrganization
Short | If present, this organization represents the provider organization where the person is claiming to be a patient.
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
Label | If present, this organization represents the provider organization where the person is claiming to be a patient.
922. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
924. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
926. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
928. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
930. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
932. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
934. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
936. ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
938. 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
940. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization|3.0.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.
Fixed Value | `ORG`
942. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
944. 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
946. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
948. 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
950. 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
952. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
954. 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
956. 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
958. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
960. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
962. 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.
964. 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
966. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
968. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
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)
970. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
972. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
974. ClinicalDocument.author
Short | The author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.
Comments | SHALL contain at least one [1..*] author (CONF:1198-28477).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
976. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
978. 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
980. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
982. ClinicalDocument.author.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
984. ClinicalDocument.author.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
986. ClinicalDocument.author.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
988. ClinicalDocument.author.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
990. ClinicalDocument.author.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
992. 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
994. ClinicalDocument.author.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
996. ClinicalDocument.author.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
998. ClinicalDocument.author.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1000. ClinicalDocument.author.time
Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (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 - Point in Time)
1002. ClinicalDocument.author.assignedAuthor
Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478).
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). (`(assignedPerson | assignedAuthoringDevice).count() = 1`) should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) (`id.where(root = '2.16.840.1.113883.4.6')`) should-us-code: SHOULD contain code (`code.exists()`) should-code: SHOULD contain code (`code.exists()`)
1004. ClinicalDocument.author.assignedAuthor.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1006. ClinicalDocument.author.assignedAuthor.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
1008. ClinicalDocument.author.assignedAuthor.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1010. ClinicalDocument.author.assignedAuthor.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1012. ClinicalDocument.author.assignedAuthor.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1014. ClinicalDocument.author.assignedAuthor.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1016. ClinicalDocument.author.assignedAuthor.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1018. ClinicalDocument.author.assignedAuthor.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1020. 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
1022. ClinicalDocument.author.assignedAuthor.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1024. ClinicalDocument.author.assignedAuthor.id
Comments | This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479).
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 areUnordered and Open, and can be differentiated using the following discriminators: value @ root
1026. ClinicalDocument.author.assignedAuthor.id:npi
Slice Name | npi
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | should-extension: SHOULD contain extension (`extension.exists()`)
1028. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Short | If NPI is unknown, set @nullFlavor to UNK
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1030. ClinicalDocument.author.assignedAuthor.id:npi.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
1032. ClinicalDocument.author.assignedAuthor.id:npi.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
1034. ClinicalDocument.author.assignedAuthor.id:npi.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`
1036. ClinicalDocument.author.assignedAuthor.id:npi.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
1038. 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`.
1040. ClinicalDocument.author.assignedAuthor.code
Short | When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-28481).
Control | 0..1
Binding | For example codes, see CDARoleCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1042. 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..0
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1044. 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.
Control | 1..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.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
1046. 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
1048. 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
1050. 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
1052. 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
1054. 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`.
1056. 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`.
1058. 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
1060. 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
1062. 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
1064. ClinicalDocument.author.assignedAuthor.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1066. ClinicalDocument.author.assignedAuthor.addr
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)
1068. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1070. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1072. 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.
1074. 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
1076. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1078. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | MAY contain assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1080. ClinicalDocument.author.assignedAuthor.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1082. ClinicalDocument.author.assignedAuthor.assignedPerson.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
1084. ClinicalDocument.author.assignedAuthor.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1086. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1088. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1090. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1092. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1094. ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1096. 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
1098. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1100. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1102. ClinicalDocument.author.assignedAuthor.assignedPerson.name
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))
1104. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1106. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1108. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1110. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1112. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1114. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1116. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1118. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1120. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1122. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1124. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1126. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1128. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1130. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1132. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | MAY contain assignedAuthoringDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
1134. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1136. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1138. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1140. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1142. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1144. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1146. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1148. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1150. 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
1152. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassDevice (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice|3.0.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.
Fixed Value | `DEV`
1154. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1156. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control | 0..1
Binding | For example codes, see CDAEntityCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1158. 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 ManufacturerModelNameExample (2.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample|2.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
1160. 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 SoftwareNameExample (2.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample|2.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
1162. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
1164. ClinicalDocument.author.assignedAuthor.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1166. ClinicalDocument.dataEnterer
Short | The dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:1198-28678).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
Alternate Names | Transcriptionist
1168. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1170. 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
1172. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1174. ClinicalDocument.dataEnterer.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1176. ClinicalDocument.dataEnterer.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1178. ClinicalDocument.dataEnterer.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1180. ClinicalDocument.dataEnterer.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1182. ClinicalDocument.dataEnterer.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1184. 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
1186. ClinicalDocument.dataEnterer.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1188. ClinicalDocument.dataEnterer.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1190. ClinicalDocument.dataEnterer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
1192. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1194. ClinicalDocument.dataEnterer.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1196. ClinicalDocument.dataEnterer.assignedEntity.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
1198. ClinicalDocument.dataEnterer.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1200. ClinicalDocument.dataEnterer.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1202. ClinicalDocument.dataEnterer.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1204. ClinicalDocument.dataEnterer.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1206. ClinicalDocument.dataEnterer.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1208. ClinicalDocument.dataEnterer.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1210. 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
1212. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1214. 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
1216. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1218. 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
1220. 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
1222. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
1224. 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
1226. ClinicalDocument.dataEnterer.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`.
1228. ClinicalDocument.dataEnterer.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1230. ClinicalDocument.dataEnterer.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1232. ClinicalDocument.dataEnterer.assignedEntity.addr
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)
1234. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1236. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1238. 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.
1240. 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
1242. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1244. 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
1246. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1248. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1250. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1252. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1254. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1256. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1258. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1260. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1262. 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
1264. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1266. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1268. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name
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))
1270. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1272. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1274. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1276. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1278. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1280. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1282. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1284. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1286. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1288. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1290. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1292. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1294. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1296. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1298. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1300. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
1302. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
1304. ClinicalDocument.informant
Definition | An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.
Short | Person that provides relevant information
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 areUnordered and Open, and can be differentiated using the following discriminators: exists @ relatedEntity exists @ assignedEntity
1306. ClinicalDocument.informant:provider
Slice Name | provider
Definition | An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.
Short | The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
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
1308. ClinicalDocument.informant:provider.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.informant:provider.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.informant:provider.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1314. ClinicalDocument.informant:provider.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1316. ClinicalDocument.informant:provider.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1318. ClinicalDocument.informant:provider.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1320. ClinicalDocument.informant:provider.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1322. ClinicalDocument.informant:provider.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1324. ClinicalDocument.informant:provider.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
1326. ClinicalDocument.informant:provider.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1328. ClinicalDocument.informant:provider.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1330. ClinicalDocument.informant:provider.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1332. ClinicalDocument.informant:provider.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1334. ClinicalDocument.informant:provider.assignedEntity.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
1336. ClinicalDocument.informant:provider.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1338. ClinicalDocument.informant:provider.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1340. ClinicalDocument.informant:provider.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1342. ClinicalDocument.informant:provider.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1344. ClinicalDocument.informant:provider.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1346. ClinicalDocument.informant:provider.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1348. ClinicalDocument.informant:provider.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
1350. ClinicalDocument.informant:provider.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1352. ClinicalDocument.informant:provider.assignedEntity.id
Short | 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).
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1354. ClinicalDocument.informant:provider.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`.
1356. ClinicalDocument.informant:provider.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 (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1358. ClinicalDocument.informant:provider.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1360. ClinicalDocument.informant:provider.assignedEntity.addr
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)
1362. ClinicalDocument.informant:provider.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1364. ClinicalDocument.informant:provider.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
1366. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1368. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1370. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1372. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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.informant:provider.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1376. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1378. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1380. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1382. ClinicalDocument.informant:provider.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
1384. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1386. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1388. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name
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))
1390. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1392. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1394. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1396. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1398. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1400. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1402. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1404. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1406. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1408. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1410. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1414. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1416. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1418. ClinicalDocument.informant:provider.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1420. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
1422. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
1424. ClinicalDocument.informant:provider.relatedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1426. ClinicalDocument.informant:non-provider
Slice Name | non-provider
Definition | An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.
Short | The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
1428. ClinicalDocument.informant:non-provider.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1430. ClinicalDocument.informant:non-provider.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
1432. ClinicalDocument.informant:non-provider.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1434. ClinicalDocument.informant:non-provider.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1436. ClinicalDocument.informant:non-provider.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1438. ClinicalDocument.informant:non-provider.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1440. ClinicalDocument.informant:non-provider.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1442. ClinicalDocument.informant:non-provider.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1444. ClinicalDocument.informant:non-provider.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
1446. ClinicalDocument.informant:non-provider.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1448. ClinicalDocument.informant:non-provider.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1450. ClinicalDocument.informant:non-provider.assignedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1452. ClinicalDocument.informant:non-provider.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1454. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1456. ClinicalDocument.informant:non-provider.relatedEntity.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
1458. ClinicalDocument.informant:non-provider.relatedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1460. ClinicalDocument.informant:non-provider.relatedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1462. ClinicalDocument.informant:non-provider.relatedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1464. ClinicalDocument.informant:non-provider.relatedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1466. ClinicalDocument.informant:non-provider.relatedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1468. ClinicalDocument.informant:non-provider.relatedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1470. ClinicalDocument.informant:non-provider.relatedEntity.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
1472. ClinicalDocument.informant:non-provider.relatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from CDARoleClassMutualRelationship (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship` )
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.
1474. ClinicalDocument.informant:non-provider.relatedEntity.code
Comments | This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683).
Control | 0..1
Binding | For example codes, see PersonalRelationshipRoleType (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants | should-us-code-attr: SHOULD contain @code (`code.exists()`)
1476. ClinicalDocument.informant:non-provider.relatedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1478. ClinicalDocument.informant:non-provider.relatedEntity.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, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28684).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.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
1480. ClinicalDocument.informant:non-provider.relatedEntity.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
1482. ClinicalDocument.informant:non-provider.relatedEntity.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
1484. ClinicalDocument.informant:non-provider.relatedEntity.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
1486. ClinicalDocument.informant:non-provider.relatedEntity.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
1488. ClinicalDocument.informant:non-provider.relatedEntity.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`.
1490. ClinicalDocument.informant:non-provider.relatedEntity.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`.
1492. ClinicalDocument.informant:non-provider.relatedEntity.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
1494. ClinicalDocument.informant:non-provider.relatedEntity.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
1496. ClinicalDocument.informant:non-provider.relatedEntity.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
1498. ClinicalDocument.informant:non-provider.relatedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1500. ClinicalDocument.informant:non-provider.relatedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1502. ClinicalDocument.informant:non-provider.relatedEntity.effectiveTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
1504. ClinicalDocument.informant:non-provider.relatedEntity.relatedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
1506. ClinicalDocument.custodian
Definition | Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.
Short | The custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.
Comments | SHALL contain exactly one [1..1] custodian (CONF:1198-28685).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
Requirements | The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.
1508. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1510. 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
1512. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1514. ClinicalDocument.custodian.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1516. ClinicalDocument.custodian.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1518. ClinicalDocument.custodian.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1520. ClinicalDocument.custodian.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1522. ClinicalDocument.custodian.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1524. 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
1526. ClinicalDocument.custodian.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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 | `CST`
1528. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
1530. ClinicalDocument.custodian.assignedCustodian.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1532. ClinicalDocument.custodian.assignedCustodian.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
1534. ClinicalDocument.custodian.assignedCustodian.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1536. ClinicalDocument.custodian.assignedCustodian.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1538. ClinicalDocument.custodian.assignedCustodian.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1540. ClinicalDocument.custodian.assignedCustodian.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1542. ClinicalDocument.custodian.assignedCustodian.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1544. ClinicalDocument.custodian.assignedCustodian.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1546. 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
1548. ClinicalDocument.custodian.assignedCustodian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1550. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Short | The representedCustodianOrganization may be the person when the document is not maintained by an organization.
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-28687).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
1552. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1554. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1556. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1558. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1560. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1562. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1564. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1566. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1568. 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
1570. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization|3.0.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.
Fixed Value | `ORG`
1572. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1574. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Short | The combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-28688).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1576. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1578. 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
1580. 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
1582. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
1584. 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
1586. 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
1588. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1590. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1592. 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.
1594. 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
1596. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1598. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom
Short | The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
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`telecom`.
1600. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
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)
1602. ClinicalDocument.informationRecipient
Short | The informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:1198-28690).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
1604. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1606. 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
1608. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1610. ClinicalDocument.informationRecipient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1612. ClinicalDocument.informationRecipient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1614. ClinicalDocument.informationRecipient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1616. ClinicalDocument.informationRecipient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1618. ClinicalDocument.informationRecipient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1620. 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
1622. ClinicalDocument.informationRecipient.typeCode
Control | 0..1
Binding | The codes SHALL be taken from XInformationRecipient (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.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.
Default Value | `PRCP`
1624. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
Invariants | should-id: SHOULD contain id (`id.exists()`)
1626. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1628. ClinicalDocument.informationRecipient.intendedRecipient.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
1630. ClinicalDocument.informationRecipient.intendedRecipient.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1632. ClinicalDocument.informationRecipient.intendedRecipient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1634. ClinicalDocument.informationRecipient.intendedRecipient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1636. ClinicalDocument.informationRecipient.intendedRecipient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1638. ClinicalDocument.informationRecipient.intendedRecipient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1640. ClinicalDocument.informationRecipient.intendedRecipient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1642. 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
1644. ClinicalDocument.informationRecipient.intendedRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAInformationRecipientRole (required to `http://hl7.org/cda/stds/core/ValueSet/CDAInformationRecipientRole` )
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`
1646. ClinicalDocument.informationRecipient.intendedRecipient.id
Short | The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
Comments | This intendedRecipient SHOULD contain zero or more [0..*] id (CONF:1198-28692).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants | should-root: SHOULD contain @root (`root.exists()`)
1648. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1650. ClinicalDocument.informationRecipient.intendedRecipient.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
1652. ClinicalDocument.informationRecipient.intendedRecipient.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
1654. ClinicalDocument.informationRecipient.intendedRecipient.id.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Short | For a provider, the id/@root ="2.16.840.1.113883.4.6" indicates the National Provider Identifier where id/@extension is the NPI number for the provider. The ids MAY reference the id of a person or organization entity specified elsewhere in the document.
Comments | The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693).
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
1656. ClinicalDocument.informationRecipient.intendedRecipient.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
1658. 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`.
1660. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1662. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1664. 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
1666. ClinicalDocument.informationRecipient.intendedRecipient.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1668. ClinicalDocument.informationRecipient.intendedRecipient.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
1670. ClinicalDocument.informationRecipient.intendedRecipient.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1672. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1674. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1676. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1678. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1680. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1682. 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
1684. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1686. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1688. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
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))
1690. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1692. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1694. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1696. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1698. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1700. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1702. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1704. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1706. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1708. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1710. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1712. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1714. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1716. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code
Control | 1..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`.
1718. 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
1720. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1722. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1724. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1726. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1728. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1730. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1732. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1734. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1736. 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
1738. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization|3.0.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.
Fixed Value | `ORG`
1740. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1742. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1744. 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
1746. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1748. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1750. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1752. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
1754. ClinicalDocument.legalAuthenticator
Short | In a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) Based on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Comments | MAY contain zero or one [0..1] legalAuthenticator (CONF:1198-28694).
Control | 0..1 This element is affected by the following invariants: should-legalAuthenticator
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Requirements | While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.
1756. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1758. 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
1760. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1762. ClinicalDocument.legalAuthenticator.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1764. ClinicalDocument.legalAuthenticator.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1766. ClinicalDocument.legalAuthenticator.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1768. ClinicalDocument.legalAuthenticator.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1770. ClinicalDocument.legalAuthenticator.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1772. 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
1774. ClinicalDocument.legalAuthenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1776. ClinicalDocument.legalAuthenticator.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
1778. ClinicalDocument.legalAuthenticator.time
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (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 - Point in Time)
1780. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
Control | 1..1
Binding | The codes SHALL be taken from CDASignatureCode (required to `http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Invariants | signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (`code.exists() implies code != 'X'`)
1782. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1784. 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`
1786. 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
1788. 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
1790. 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
1792. 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
1794. 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`.
1796. 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`.
1798. 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
1800. 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
1802. 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
1804. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Definition | A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.
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. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013.
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`.
1806. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1808. ClinicalDocument.legalAuthenticator.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1810. ClinicalDocument.legalAuthenticator.assignedEntity.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
1812. ClinicalDocument.legalAuthenticator.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1814. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1816. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1818. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1820. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1822. ClinicalDocument.legalAuthenticator.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1824. 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
1826. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
1828. ClinicalDocument.legalAuthenticator.assignedEntity.id
Short | The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28696).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1830. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1832. 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
1834. 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
1836. 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.
Short | MAY contain '2.16.840.1.113883.4.6' (NPI)
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
1838. 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
1840. ClinicalDocument.legalAuthenticator.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`.
1842. ClinicalDocument.legalAuthenticator.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697).
Control | 0..1
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1844. ClinicalDocument.legalAuthenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1846. ClinicalDocument.legalAuthenticator.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 Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28698).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.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
1848. ClinicalDocument.legalAuthenticator.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
1850. ClinicalDocument.legalAuthenticator.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
1852. ClinicalDocument.legalAuthenticator.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
1854. ClinicalDocument.legalAuthenticator.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
1856. ClinicalDocument.legalAuthenticator.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`.
1858. ClinicalDocument.legalAuthenticator.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`.
1860. ClinicalDocument.legalAuthenticator.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
1862. ClinicalDocument.legalAuthenticator.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
1864. ClinicalDocument.legalAuthenticator.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
1866. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
1868. ClinicalDocument.legalAuthenticator.assignedEntity.addr
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)
1870. 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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1872. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1874. 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.
1876. 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
1878. 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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
1880. 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
1882. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1884. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1886. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1888. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1890. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1892. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1894. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1896. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1898. 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
1900. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
1902. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
1904. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
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))
1906. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
1908. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
1910. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1912. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1914. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1916. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1918. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1920. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1922. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1924. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1926. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1928. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
1930. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
1932. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
1934. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1936. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
1938. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
1940. ClinicalDocument.authenticator
Definition | Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.
Short | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
Comments | MAY contain zero or more [0..*] authenticator (CONF:1198-28699).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
1942. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1944. ClinicalDocument.authenticator.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
1946. ClinicalDocument.authenticator.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1948. ClinicalDocument.authenticator.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1950. ClinicalDocument.authenticator.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
1952. ClinicalDocument.authenticator.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
1954. ClinicalDocument.authenticator.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
1956. ClinicalDocument.authenticator.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
1958. ClinicalDocument.authenticator.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
1960. ClinicalDocument.authenticator.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
1962. ClinicalDocument.authenticator.time
Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (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 - Point in Time)
1964. ClinicalDocument.authenticator.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
Control | 1..1
Binding | The codes SHALL be taken from CDASignatureCode (required to `http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Invariants | signature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (`code.exists() implies code != 'X'`)
1966. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1968. ClinicalDocument.authenticator.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`
1970. ClinicalDocument.authenticator.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
1972. ClinicalDocument.authenticator.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
1974. ClinicalDocument.authenticator.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
1976. ClinicalDocument.authenticator.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
1978. ClinicalDocument.authenticator.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`.
1980. ClinicalDocument.authenticator.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`.
1982. ClinicalDocument.authenticator.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
1984. ClinicalDocument.authenticator.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
1986. ClinicalDocument.authenticator.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
1988. ClinicalDocument.authenticator.sdtcSignatureText
Definition | A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.
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. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.
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`.
1990. ClinicalDocument.authenticator.assignedEntity
Comments | The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-code: SHOULD contain code (`code.exists()`)
1992. ClinicalDocument.authenticator.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
1994. ClinicalDocument.authenticator.assignedEntity.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
1996. ClinicalDocument.authenticator.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
1998. ClinicalDocument.authenticator.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2000. ClinicalDocument.authenticator.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2002. ClinicalDocument.authenticator.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2004. ClinicalDocument.authenticator.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2006. ClinicalDocument.authenticator.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2008. ClinicalDocument.authenticator.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
2010. ClinicalDocument.authenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
2012. ClinicalDocument.authenticator.assignedEntity.id
Short | The combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2014. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2016. ClinicalDocument.authenticator.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
2018. ClinicalDocument.authenticator.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
2020. ClinicalDocument.authenticator.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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
2022. ClinicalDocument.authenticator.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
2024. ClinicalDocument.authenticator.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`.
2026. ClinicalDocument.authenticator.assignedEntity.code
Comments | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2028. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2030. ClinicalDocument.authenticator.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 (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` )
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
2032. ClinicalDocument.authenticator.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
2034. ClinicalDocument.authenticator.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
2036. ClinicalDocument.authenticator.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
2038. ClinicalDocument.authenticator.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
2040. ClinicalDocument.authenticator.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`.
2042. ClinicalDocument.authenticator.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`.
2044. ClinicalDocument.authenticator.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
2046. ClinicalDocument.authenticator.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
2048. ClinicalDocument.authenticator.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
2050. ClinicalDocument.authenticator.assignedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
2052. ClinicalDocument.authenticator.assignedEntity.addr
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)
2054. ClinicalDocument.authenticator.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
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
2056. ClinicalDocument.authenticator.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2058. ClinicalDocument.authenticator.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.
2060. ClinicalDocument.authenticator.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
2062. ClinicalDocument.authenticator.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) (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20` )
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
2064. ClinicalDocument.authenticator.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
2066. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2068. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
2070. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2072. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2074. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2076. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2078. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2080. ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2082. ClinicalDocument.authenticator.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
2084. ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject|3.0.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.
Fixed Value | `PSN`
2086. ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
2088. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name
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))
2090. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc
Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
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`.
2092. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition | Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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`.
2094. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2096. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
2098. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2100. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2102. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2104. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2106. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2108. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2110. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
2112. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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.
Fixed Value | `PRS`
2114. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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 | `INSTANCE`
2116. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control | 1..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`.
2118. ClinicalDocument.authenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2120. ClinicalDocument.authenticator.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
2122. ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
2124. ClinicalDocument.participant
Definition | Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.
Short | The participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)
Comments | MAY contain zero or more [0..*] participant (CONF:1198-28703).
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). (`associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()`) 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). (`typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33')`)
2126. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2128. 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
2130. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2132. ClinicalDocument.participant.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2134. ClinicalDocument.participant.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2136. ClinicalDocument.participant.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2138. ClinicalDocument.participant.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2140. ClinicalDocument.participant.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2142. 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
2144. ClinicalDocument.participant.typeCode
Short | Unless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30
Comments | The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704).
Control | 1..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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.
2146. ClinicalDocument.participant.contextControlCode
Control | 0..1
Binding | The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl` )
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`
2148. ClinicalDocument.participant.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2150. 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(US Realm Date and Time - Interval)
2152. ClinicalDocument.participant.associatedEntity
Comments | The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
Invariants | should-code: SHOULD contain code (`code.exists()`)
2154. ClinicalDocument.participant.associatedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2156. ClinicalDocument.participant.associatedEntity.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
2158. ClinicalDocument.participant.associatedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2160. ClinicalDocument.participant.associatedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2162. ClinicalDocument.participant.associatedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2164. ClinicalDocument.participant.associatedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2166. ClinicalDocument.participant.associatedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2168. ClinicalDocument.participant.associatedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2170. ClinicalDocument.participant.associatedEntity.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2172. ClinicalDocument.participant.associatedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from CDARoleClassAssociative (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative` )
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.
2174. ClinicalDocument.participant.associatedEntity.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2176. ClinicalDocument.participant.associatedEntity.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`.
2178. ClinicalDocument.participant.associatedEntity.code
Comments | This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2180. ClinicalDocument.participant.associatedEntity.sdtcSpecialty
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to `http://hl7.org/fhir/ValueSet/c80-practice-codes` )
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`specialty`.
2182. ClinicalDocument.participant.associatedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
2184. ClinicalDocument.participant.associatedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
2186. ClinicalDocument.participant.associatedEntity.associatedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
2188. ClinicalDocument.participant.associatedEntity.scopingOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2190. ClinicalDocument.inFulfillmentOf
Short | The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray.
Comments | MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
2192. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2194. 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
2196. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2198. ClinicalDocument.inFulfillmentOf.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2200. ClinicalDocument.inFulfillmentOf.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2202. ClinicalDocument.inFulfillmentOf.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2204. ClinicalDocument.inFulfillmentOf.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2206. ClinicalDocument.inFulfillmentOf.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2208. 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
2210. ClinicalDocument.inFulfillmentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipFulfills (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipFulfills|2.0.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.
Fixed Value | `FLFS`
2212. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
2214. ClinicalDocument.inFulfillmentOf.order.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2216. ClinicalDocument.inFulfillmentOf.order.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
2218. ClinicalDocument.inFulfillmentOf.order.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2220. ClinicalDocument.inFulfillmentOf.order.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2222. ClinicalDocument.inFulfillmentOf.order.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2224. ClinicalDocument.inFulfillmentOf.order.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2226. ClinicalDocument.inFulfillmentOf.order.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2228. ClinicalDocument.inFulfillmentOf.order.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2230. 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
2232. ClinicalDocument.inFulfillmentOf.order.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2234. ClinicalDocument.inFulfillmentOf.order.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMoodIntent (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent` )
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`
2236. ClinicalDocument.inFulfillmentOf.order.id
Short | A scheduled appointment or service event in a practice management system may be represented using this id element.
Comments | This order SHALL contain at least one [1..*] id (CONF:1198-28709).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2238. ClinicalDocument.inFulfillmentOf.order.code
Control | 0..1
Binding | For example codes, see ActCode (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2240. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2242. ClinicalDocument.documentationOf
Short | The main Act being documented
Comments | MAY contain zero or more [0..*] documentationOf (CONF:1198-28710).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
2244. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2246. 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
2248. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2250. ClinicalDocument.documentationOf.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2252. ClinicalDocument.documentationOf.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2254. ClinicalDocument.documentationOf.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2256. ClinicalDocument.documentationOf.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2258. ClinicalDocument.documentationOf.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2260. 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
2262. ClinicalDocument.documentationOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActRelationshipType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType` )
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`
2264. ClinicalDocument.documentationOf.serviceEvent
Short | A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.
Comments | The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
Invariants | should-us-performer: SHOULD contain performer (`performer.exists()`) should-code: SHOULD contain code (`code.exists()`) should-performer: SHOULD contain performer (`performer.exists()`)
2266. ClinicalDocument.documentationOf.serviceEvent.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2268. ClinicalDocument.documentationOf.serviceEvent.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
2270. ClinicalDocument.documentationOf.serviceEvent.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2272. ClinicalDocument.documentationOf.serviceEvent.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2274. ClinicalDocument.documentationOf.serviceEvent.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2276. ClinicalDocument.documentationOf.serviceEvent.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2278. ClinicalDocument.documentationOf.serviceEvent.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2280. ClinicalDocument.documentationOf.serviceEvent.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2282. 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
2284. ClinicalDocument.documentationOf.serviceEvent.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2286. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2288. ClinicalDocument.documentationOf.serviceEvent.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2290. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Short | The code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.
Comments | This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2292. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments | This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
2294. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2296. 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.
Short | Either @value or low/high should be present, but not both
Control | 0..1
Type | dateTime(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.
2298. 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 CDASetOperator (required to `http://hl7.org/cda/stds/core/ValueSet/CDASetOperator` )
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`
2300. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Short | **MAY** be precise to at least the second
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
Invariants | ts-shall-day: **SHALL** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`) ts-should-minute: **SHOULD** be precise to at least the minute (`nullFlavor.exists() or value.toString().length() > 10`)
2302. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2304. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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 | dateTime(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.
2306. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive
Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).
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.
Default Value | `true`
2308. 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
2310. 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
2312. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Short | **MAY** be precise to at least the second
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
Invariants | ts-shall-day: **SHALL** be precise to at least the day (`nullFlavor.exists() or value.toString().length() >= 10`) ts-should-minute: **SHOULD** be precise to at least the minute (`nullFlavor.exists() or value.toString().length() > 10`)
2314. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2316. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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 | dateTime(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.
2318. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive
Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).
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.
Default Value | `true`
2320. ClinicalDocument.documentationOf.serviceEvent.performer
Short | SHOULD contain performer
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713).
Control | 0..* This element is affected by the following invariants: should-us-performer, should-performer
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
2322. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2324. 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
2326. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2328. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2330. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2332. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2334. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2336. ClinicalDocument.documentationOf.serviceEvent.performer.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2338. 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
2340. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840).
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601` )
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.
2342. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Short | When indicating the performer was the primary care physician, implementers should indicate "PCP" as the 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
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
2344. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2346. 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 SHALL be taken from ParticipationFunction (required to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267` )
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
2348. 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
2350. 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
2352. 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
2354. 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
2356. 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`.
2358. 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`.
2360. 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
2362. 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
2364. 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
2366. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
2368. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-us-code: SHOULD contain code (`code.exists()`)
2370. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2372. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2374. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2376. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2378. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2380. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2382. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2384. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2386. 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
2388. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity|3.0.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.
Fixed Value | `ASSIGNED`
2390. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Short | The combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2392. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2394. 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
2396. 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
2398. 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
Invariants | should-npi: SHOULD be NPI (`$this = '2.16.840.1.113883.4.6'`)
2400. 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
2402. ClinicalDocument.documentationOf.serviceEvent.performer.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`.
2404. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Short | If the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set
Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718).
Control | 0..1
Binding | The codes SHOULD be taken from Personal And Legal Relationship Role Type (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2406. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcSpecialty
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`specialty`.
2408. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
2410. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
2412. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
2414. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2416. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
2418. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
2420. ClinicalDocument.relatedDocument
Short | Source of a document revision, addenda, or transformation
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
Requirements | A conformant CDA document can have a single relatedDocument with typeCode 'APND'; a single relatedDocument with typeCode 'RPLC'; a single relatedDocument with typeCode 'XFRM'; a combination of two relatedDocuments with typeCodes 'XFRM' and 'RPLC'; or a combination of two relatedDocuments with typeCodes 'XFRM' and 'APND'. No other combinations are allowed.
2422. ClinicalDocument.authorization
Short | The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document.
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
2424. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2426. 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
2428. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2430. ClinicalDocument.authorization.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2432. ClinicalDocument.authorization.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2434. ClinicalDocument.authorization.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2436. ClinicalDocument.authorization.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2438. ClinicalDocument.authorization.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2440. 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
2442. ClinicalDocument.authorization.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipAuthorizedBy (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy|3.0.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.
Fixed Value | `AUTH`
2444. 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
2446. ClinicalDocument.authorization.consent.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2448. ClinicalDocument.authorization.consent.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
2450. ClinicalDocument.authorization.consent.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2452. ClinicalDocument.authorization.consent.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2454. ClinicalDocument.authorization.consent.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2456. ClinicalDocument.authorization.consent.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2458. ClinicalDocument.authorization.consent.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2460. ClinicalDocument.authorization.consent.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2462. 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
2464. ClinicalDocument.authorization.consent.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2466. ClinicalDocument.authorization.consent.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2468. 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
2470. 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 | For example codes, see ActCode (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2472. 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 (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
2474. ClinicalDocument.authorization.consent.statusCode.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2476. ClinicalDocument.authorization.consent.statusCode.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: 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.
Label | Code
Fixed Value | `completed`
2478. ClinicalDocument.authorization.consent.statusCode.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
2480. ClinicalDocument.authorization.consent.statusCode.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
2482. ClinicalDocument.authorization.consent.statusCode.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
2484. ClinicalDocument.authorization.consent.statusCode.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
2486. ClinicalDocument.authorization.consent.statusCode.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
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`.
2488. ClinicalDocument.authorization.consent.statusCode.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
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`.
2490. ClinicalDocument.authorization.consent.statusCode.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
2492. ClinicalDocument.authorization.consent.statusCode.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
2494. ClinicalDocument.authorization.consent.statusCode.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
2496. ClinicalDocument.componentOf
Definition | This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.
Short | The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.
Comments | MAY contain zero or one [0..1] componentOf (CONF:4537-9955).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
2498. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2500. 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
2502. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2504. ClinicalDocument.componentOf.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2506. ClinicalDocument.componentOf.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2508. ClinicalDocument.componentOf.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2510. ClinicalDocument.componentOf.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2512. ClinicalDocument.componentOf.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2514. 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
2516. ClinicalDocument.componentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent|3.0.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.
Fixed Value | `COMP`
2518. 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
Invariants | should-responsibleParty: SHOULD contain responsibleParty (`responsibleParty.exists()`)
2520. ClinicalDocument.componentOf.encompassingEncounter.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2522. ClinicalDocument.componentOf.encompassingEncounter.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
2524. ClinicalDocument.componentOf.encompassingEncounter.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2526. ClinicalDocument.componentOf.encompassingEncounter.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2528. ClinicalDocument.componentOf.encompassingEncounter.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2530. ClinicalDocument.componentOf.encompassingEncounter.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2532. ClinicalDocument.componentOf.encompassingEncounter.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2534. ClinicalDocument.componentOf.encompassingEncounter.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2536. 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
2538. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActClass (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` )
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`
2540. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2542. 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
2544. ClinicalDocument.componentOf.encompassingEncounter.code
Comments | This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873).
Control | 0..1
Binding | The codes SHOULD be taken from Act Encounter Codes (preferred to `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2546. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Comments | This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
2548. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
Definition | This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.
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`.
2550. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control | 0..1
Binding | For example codes, see USEncounterDischargeDisposition (5.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition|5.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2552. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Definition | The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.
Comments | This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2554. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2556. 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
2558. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2560. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2562. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2564. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2566. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2568. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2570. 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
2572. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control | 0..1
Binding | The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType` )
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`
2574. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Comments | The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (`assignedPerson.exists() or representedOrganization.exists()`)
2576. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
2578. 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). The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow. When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2580. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2582. 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
2584. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2586. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2588. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2590. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2592. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2594. ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2596. 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
2598. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetLocation (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation|3.0.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.
Fixed Value | `LOC`
2600. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
2602. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2604. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2606. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2608. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2610. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2612. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2614. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2616. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2618. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2620. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassServiceDeliveryLocation (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassServiceDeliveryLocation|3.0.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.
Default Value | `SDLOC`
2622. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2624. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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`.
2626. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.code
Control | 0..1
Binding | For example codes, see ServiceDeliveryLocationRoleType (3.0.0) (example to `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType|3.0.0` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2628. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Place
2630. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2632. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2634. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2636. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2638. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2640. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2642. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2644. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2646. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.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
2648. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassPlace|3.0.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.
Fixed Value | `PLC`
2650. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer|3.0.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.
Fixed Value | `INSTANCE`
2652. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
2654. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.addr
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Address
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
2656. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.serviceProviderOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2658. ClinicalDocument.component
Short | Body of the document
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component
2660. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2662. 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
2664. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2666. ClinicalDocument.component.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2668. ClinicalDocument.component.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2670. ClinicalDocument.component.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2672. ClinicalDocument.component.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2674. ClinicalDocument.component.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2676. 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
2678. ClinicalDocument.component.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent|3.0.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.
Fixed Value | `COMP`
2680. 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`
2682. ClinicalDocument.component.nonXMLBody
Short | A body in some format other than XML.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody
2684. ClinicalDocument.component.structuredBody
Short | A body comprised of one or more document sections.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
2686. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2688. 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
2690. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2692. ClinicalDocument.component.structuredBody.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2694. ClinicalDocument.component.structuredBody.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2696. ClinicalDocument.component.structuredBody.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2698. ClinicalDocument.component.structuredBody.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2700. ClinicalDocument.component.structuredBody.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2702. 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
2704. ClinicalDocument.component.structuredBody.classCode
Control | 0..1
Binding | The codes SHALL be taken from ActClassRecordOrganizer (3.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer|3.0.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.
Fixed Value | `DOCBODY`
2706. ClinicalDocument.component.structuredBody.moodCode
Control | 0..1
Binding | The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` )
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`
2708. ClinicalDocument.component.structuredBody.confidentialityCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2710. ClinicalDocument.component.structuredBody.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
2712. ClinicalDocument.component.structuredBody.component
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
Slicing | This element introduces a set of slices on `ClinicalDocument.component.structuredBody.component`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ section
2714. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2716. 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
2718. 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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2720. ClinicalDocument.component.structuredBody.component.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2722. ClinicalDocument.component.structuredBody.component.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2724. ClinicalDocument.component.structuredBody.component.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2726. ClinicalDocument.component.structuredBody.component.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2728. ClinicalDocument.component.structuredBody.component.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2730. 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
2732. 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`
2734. 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`
2736. ClinicalDocument.component.structuredBody.component.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2738. ClinicalDocument.component.structuredBody.component:source-form
Slice Name | source-form
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2740. ClinicalDocument.component.structuredBody.component:source-form.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2742. ClinicalDocument.component.structuredBody.component:source-form.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
2744. ClinicalDocument.component.structuredBody.component:source-form.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2746. ClinicalDocument.component.structuredBody.component:source-form.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2748. ClinicalDocument.component.structuredBody.component:source-form.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2750. ClinicalDocument.component.structuredBody.component:source-form.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2752. ClinicalDocument.component.structuredBody.component:source-form.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2754. ClinicalDocument.component.structuredBody.component:source-form.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2756. ClinicalDocument.component.structuredBody.component:source-form.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
2758. ClinicalDocument.component.structuredBody.component:source-form.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`
2760. ClinicalDocument.component.structuredBody.component:source-form.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`
2762. ClinicalDocument.component.structuredBody.component:source-form.section
Short | Person's signature and Information about Witnesses or Notary required to complete a valid document
Comments | SHOULD contain 0..* Esignature ObservationMedia Entry where the id references the associated authenticator in the header.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Witness And Notary Section)
2764. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment
Slice Name | healthcare-agent-appointment
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2766. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2768. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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
2770. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2772. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2774. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2776. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2778. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2780. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2782. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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
2784. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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`
2786. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.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`
2788. ClinicalDocument.component.structuredBody.component:healthcare-agent-appointment.section
Short | Consent information that appoints healthcare agents
Comments | SHOULD contain 0..1 Healthcare Agent Consent Entry. This entry includes options for expressing why no healthcare agent(s) were appointed.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Healthcare Agent Appointment Section)
2790. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences
Slice Name | treatment-intervention-preferences
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2792. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2794. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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
2796. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2798. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2800. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2802. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2804. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2806. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2808. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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
2810. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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`
2812. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.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`
2814. ClinicalDocument.component.structuredBody.component:treatment-intervention-preferences.section
Short | Persion's conditional treatment intervention preferences
Comments | SHOULD contain 0..* Treatment Intervention Preference Entry
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Treatment Intervention Preferences Section)
2816. ClinicalDocument.component.structuredBody.component:care-experience-preferences
Slice Name | care-experience-preferences
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2818. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2820. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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
2822. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2824. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2826. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2828. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2830. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2832. ClinicalDocument.component.structuredBody.component:care-experience-preferences.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2834. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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
2836. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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`
2838. ClinicalDocument.component.structuredBody.component:care-experience-preferences.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`
2840. ClinicalDocument.component.structuredBody.component:care-experience-preferences.section
Short | Person's conditional care experience preferences
Comments | SHOULD contain 0..* Care Experience Preference Entry.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Care Experience Preferences Section)
2842. ClinicalDocument.component.structuredBody.component:upon-death-preferences
Slice Name | upon-death-preferences
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2844. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2846. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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
2848. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2850. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2852. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2854. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2856. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2858. ClinicalDocument.component.structuredBody.component:upon-death-preferences.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2860. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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
2862. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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`
2864. ClinicalDocument.component.structuredBody.component:upon-death-preferences.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`
2866. ClinicalDocument.component.structuredBody.component:upon-death-preferences.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2868. ClinicalDocument.component.structuredBody.component:additional-documentation
Slice Name | additional-documentation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2870. ClinicalDocument.component.structuredBody.component:additional-documentation.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2872. ClinicalDocument.component.structuredBody.component:additional-documentation.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
2874. ClinicalDocument.component.structuredBody.component:additional-documentation.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2876. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2878. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2880. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2882. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2884. ClinicalDocument.component.structuredBody.component:additional-documentation.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2886. ClinicalDocument.component.structuredBody.component:additional-documentation.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
2888. ClinicalDocument.component.structuredBody.component:additional-documentation.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`
2890. ClinicalDocument.component.structuredBody.component:additional-documentation.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`
2892. ClinicalDocument.component.structuredBody.component:additional-documentation.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2894. ClinicalDocument.component.structuredBody.component:administrative-information
Slice Name | administrative-information
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2896. ClinicalDocument.component.structuredBody.component:administrative-information.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2898. ClinicalDocument.component.structuredBody.component:administrative-information.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
2900. ClinicalDocument.component.structuredBody.component:administrative-information.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2902. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2904. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2906. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2908. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2910. ClinicalDocument.component.structuredBody.component:administrative-information.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2912. ClinicalDocument.component.structuredBody.component:administrative-information.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
2914. ClinicalDocument.component.structuredBody.component:administrative-information.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`
2916. ClinicalDocument.component.structuredBody.component:administrative-information.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`
2918. ClinicalDocument.component.structuredBody.component:administrative-information.section
Short | Information collected for administrative reasons
Comments | SHOULD contain 0..* Advance Healthcare Directive Observation Entry.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section(Administrative Information Section)
2920. ClinicalDocument.component.structuredBody.component:completion-information
Slice Name | completion-information
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2922. ClinicalDocument.component.structuredBody.component:completion-information.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2924. ClinicalDocument.component.structuredBody.component:completion-information.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
2926. ClinicalDocument.component.structuredBody.component:completion-information.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2928. ClinicalDocument.component.structuredBody.component:completion-information.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2930. ClinicalDocument.component.structuredBody.component:completion-information.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2932. ClinicalDocument.component.structuredBody.component:completion-information.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2934. ClinicalDocument.component.structuredBody.component:completion-information.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2936. ClinicalDocument.component.structuredBody.component:completion-information.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2938. ClinicalDocument.component.structuredBody.component:completion-information.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
2940. ClinicalDocument.component.structuredBody.component:completion-information.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`
2942. ClinicalDocument.component.structuredBody.component:completion-information.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`
2944. ClinicalDocument.component.structuredBody.component:completion-information.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section
2946. ClinicalDocument.component.structuredBody.component:witness-and-notary
Slice Name | witness-and-notary
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2948. ClinicalDocument.component.structuredBody.component:witness-and-notary.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2950. ClinicalDocument.component.structuredBody.component:witness-and-notary.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
2952. ClinicalDocument.component.structuredBody.component:witness-and-notary.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
Invariants | II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
2954. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
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
2956. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
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
2958. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
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
2960. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.root
Definition | Identifies the type as an HL7 Registered model
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
Fixed Value | `2.16.840.1.113883.1.3`
2962. ClinicalDocument.component.structuredBody.component:witness-and-notary.typeId.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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
2964. ClinicalDocument.component.structuredBody.component:witness-and-notary.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
2966. ClinicalDocument.component.structuredBody.component:witness-and-notary.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`
2968. ClinicalDocument.component.structuredBody.component:witness-and-notary.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`
2970. ClinicalDocument.component.structuredBody.component:witness-and-notary.section
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Section