Paramedicine Summary Of Care CDA
0.0.1-current - ci-build

Paramedicine Summary Of Care CDA, published by IHE Patient Care Coordination Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/PCC.PCSc/ and changes regularly. See the Directory of published versions

## Logical Model: IHE_PCC_MedicalDocument_CDA - Detailed Descriptions

Draft as of 2025-11-04

Definitions for the IHE.PCC.MD.CDA 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 (`AssociatedEntity.associatedPerson.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 | 1..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
Must Support | true
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 at least one [1..1] realmCode=" ". realmCode Should be UV
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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Invariants | ihe-pcc-realmCode-1: If realmCode is present it SHOULD be UV (`realmCode.code.exists() implies realmCode.code.exists(value=#UV)`)
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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
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 | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
Invariants | ihe-pcc-realmCode-2: If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 (`realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)`)
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:uv-realm
Slice Name | uv-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
Must Support | true
48. ClinicalDocument.templateId:uv-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:uv-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:uv-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:uv-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 | `1.3.6.1.4.1.19376.1.5.3.1.1.1`
56. ClinicalDocument.templateId:uv-realm.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
58. 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 | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
60. 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
62. 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
64. 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
66. 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`
68. 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`
70. ClinicalDocument.id
Short | **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363). The uniqueId can be formatted using the following XPath expression, where $docID in the expression below represents the identifier. concat($docID/@root, $docID/@extension)
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
72. ClinicalDocument.sdtcCategory
Short | Used to categorize the document type..
Control | 0..*
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
74. ClinicalDocument.sdtcCategory:documentType
Slice Name | documentType
Control | 0..*
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`.
76. ClinicalDocument.sdtcCategory:documentType.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
78. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
80. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
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`
82. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
Pattern Value | `LOINC`
84. ClinicalDocument.sdtcCategory:documentType.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
86. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
88. ClinicalDocument.sdtcCategory:documentType.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`.
90. ClinicalDocument.sdtcCategory:documentType.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`.
92. ClinicalDocument.sdtcCategory:documentType.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
94. ClinicalDocument.sdtcCategory:documentType.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
96. ClinicalDocument.sdtcCategory:documentType.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
98. ClinicalDocument.code
Short | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
Control | 1..1
Binding | For example codes, see FHIRDocumentTypeCodes (example to `http://hl7.org/fhir/ValueSet/doc-typecodes` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
100. ClinicalDocument.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
102. ClinicalDocument.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
104. 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
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
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`
106. ClinicalDocument.code.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
Pattern Value | `LOINC`
108. 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
110. ClinicalDocument.code.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
112. 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`.
114. 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`.
116. 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
118. 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
120. 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
122. 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
124. 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.
Control | 0..1
Binding | The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
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`.
126. ClinicalDocument.effectiveTime
Comments | Times specified in clinical documents may be specified with a precision in fractional sections, and may contain a time zone offset. In the XDS Metadata, it can be precise to the second, and is always given in UTC, so the timezone offset if present must be added to the current time to obtain the UTC time.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
128. ClinicalDocument.confidentialityCode
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
130. 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
132. 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 | 0..1
Binding | The codes SHOULD be taken from Confidentiality (preferred to `http://terminology.hl7.org/ValueSet/v3-Confidentiality` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
134. 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
136. 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
138. 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
140. 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
142. 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`.
144. 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`.
146. 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
148. 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
150. 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
152. ClinicalDocument.languageCode
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
Must Support | true
154. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
156. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
158. ClinicalDocument.copyTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
160. ClinicalDocument.recordTarget
Short | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
Must Support | true
162. 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
164. 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
166. 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()`)
168. 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
170. 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
172. 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
174. 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`
176. 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
178. 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
180. 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`
182. 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`
184. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
Must Support | true
186. 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
188. 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
190. 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()`)
192. 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
194. 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
196. 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
198. 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`
200. 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
202. 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
204. ClinicalDocument.recordTarget.patientRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassRelationshipFormal (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PAT`
206. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
208. 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`.
210. ClinicalDocument.recordTarget.patientRole.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
212. ClinicalDocument.recordTarget.patientRole.telecom
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
214. 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
216. 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.
218. 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
220. 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.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
222. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
Must Support | true
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-us-addr: SHOULD contain addr (`addr.exists()`) should-maritalStatusCode: SHOULD contain maritalStatusCode (`maritalStatusCode.exists()`) should-us-languageCommunication: SHOULD contain languageCommunication (`languageCommunication.exists()`)
224. 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
226. 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
228. 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()`)
230. 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
232. 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
234. 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
236. 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`
238. 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
240. 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
242. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
244. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
246. 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
248. ClinicalDocument.recordTarget.patientRole.patient.name
Definition | A name associated with the individual.
Short | A name associated with the patient
Comments | 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
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
Invariants | iti-pdqm-patname: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. 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`.
252. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Control | 0..1
Binding | For example codes, see AdministrativeGender (example to `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
254. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
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`)
256. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
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`.
258. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | Date of Death
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`)
260. 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`.
262. 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`.
264. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
Control | 0..1
Binding | For example codes, see MaritalStatus (example to `http://terminology.hl7.org/ValueSet/v3-MaritalStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
266. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
Control | 0..1
Binding | For example codes, see ReligiousAffiliation (example to `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
268. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Control | 0..1
Binding | For example codes, see Race (example to `http://terminology.hl7.org/ValueSet/v3-Race` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
270. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Control | 0..*
Binding | For example codes, see Race (example to `http://terminology.hl7.org/ValueSet/v3-Race` )
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`.
272. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Control | 0..1
Binding | For example codes, see Ethnicity (example to `http://terminology.hl7.org/ValueSet/v3-Ethnicity` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
274. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Control | 0..*
Binding | For example codes, see Ethnicity (example to `http://terminology.hl7.org/ValueSet/v3-Ethnicity` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`ethnicGroupCode`.
276. ClinicalDocument.recordTarget.patientRole.patient.guardian
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
Must Support | true
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()`)
278. 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
280. 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
282. 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()`)
284. 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
286. 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
288. 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
290. 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`
292. 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
294. 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
296. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAgent (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `GUARD`
298. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
300. 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`.
302. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
Control | 0..1
Binding | The codes SHOULD be taken from PersonalAndLegalRelationshipRoleType (preferred to `http://terminology.hl7.org/ValueSet/v3-PersonalAndLegalRelationshipRoleType` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Must Support | true
304. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
306. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
308. 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
310. 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.
312. 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
314. 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.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
316. 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
Must Support | true
318. 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
320. 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
322. 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()`)
324. 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
326. 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
328. 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
330. 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`
332. 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
334. 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
336. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
338. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
340. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
Comments | Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
342. 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`.
344. 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`.
346. 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
348. 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
350. 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()`)
352. 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
354. 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
356. 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
358. 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`
360. 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
362. 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
364. 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`
366. 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`
368. 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`.
370. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
372. 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
374. 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
376. 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
378. 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()`)
380. 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
382. 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
384. 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
386. 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`
388. 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
390. 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
392. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassPassive (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassPassive` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `BIRTHPL`
394. 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
396. 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
398. 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
400. 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()`)
402. 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
404. 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
406. 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
408. 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`
410. 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
412. 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
414. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassPlace` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PLC`
416. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
418. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
420. 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
Must Support | true
Invariants | should-country: SHOULD contain country ()
422. 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
424. 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
426. 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
428. 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`)
430. 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`)
432. 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
434. 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`
436. 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`
438. 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
440. 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.
442. 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`
444. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
Definition | Country
Control | 0..1
Binding | The codes SHALL be taken from Country2 (required to `http://terminology.hl7.org/ValueSet/v3-Country2` )
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`)
446. 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
448. 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`
450. 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`
452. 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
454. 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.
456. 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`
458. 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`)
460. 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
462. 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`
464. 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`
466. 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
468. 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.
470. 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`
472. 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`)
474. 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
476. 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`
478. 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`
480. 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
482. 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.
484. 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`
486. 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`)
488. 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
490. 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`
492. 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`
494. 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
496. 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.
498. 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`
500. 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`)
502. 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
504. 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`
506. 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`
508. 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
510. 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.
512. 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`
514. 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`)
516. 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
518. 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`
520. 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`
522. 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
524. 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.
526. 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`
528. 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`)
530. 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
532. 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`
534. 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`
536. 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
538. 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.
540. 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`
542. 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`)
544. 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
546. 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`
548. 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`
550. 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
552. 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.
554. 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`
556. 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`)
558. 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
560. 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`
562. 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`
564. 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
566. 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.
568. 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`
570. 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`)
572. 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
574. 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`
576. 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`
578. 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
580. 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.
582. 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`
584. 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`)
586. 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
588. 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`
590. 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`
592. 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
594. 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.
596. 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`
598. 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`)
600. 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
602. 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`
604. 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`
606. 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
608. 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.
610. 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`
612. 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`)
614. 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
616. 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`
618. 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`
620. 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
622. 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.
624. 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`
626. 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`)
628. 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
630. 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`
632. 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`
634. 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
636. 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.
638. 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`
640. 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`)
642. 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
644. 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`
646. 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`
648. 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
650. 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.
652. 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`
654. 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`)
656. 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
658. 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`
660. 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`
662. 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
664. 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.
666. 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`
668. 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`)
670. 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
672. 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`
674. 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`
676. 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
678. 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.
680. 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`
682. 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`)
684. 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
686. 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`
688. 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`
690. 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
692. 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.
694. 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`
696. 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`)
698. 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
700. 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`
702. 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`
704. 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
706. 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.
708. 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`
710. 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`)
712. 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
714. 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`
716. 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`
718. 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
720. 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.
722. 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`
724. 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`)
726. 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
728. 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`
730. 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`
732. 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
734. 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.
736. 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`
738. 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`)
740. 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
742. 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`
744. 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`
746. 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
748. 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.
750. 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`
752. 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`)
754. 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
756. 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`
758. 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`
760. 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
762. 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.
764. 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`
766. 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`)
768. 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
770. 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`
772. 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`
774. 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
776. 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.
778. 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`
780. 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`)
782. 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
784. 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`
786. 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`
788. 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
790. 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.
792. 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`
794. 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`)
796. 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
798. 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`
800. 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`
802. 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
804. 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.
806. 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`
808. 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.
810. 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
812. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
Must Support | true
Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (`proficiencyLevelCode.exists()`) should-preferenceInd: SHOULD contain preferenceInd (`preferenceInd.exists()`)
814. 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
816. 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
818. 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()`)
820. 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
822. 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
824. 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
826. 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`
828. 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
830. 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
832. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Control | 1..1
Binding | The codes SHALL be taken from Languages (required to `http://terminology.hl7.org/ValueSet/Languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Must Support | true
834. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode
Control | 0..1
Binding | For example codes, see LanguageAbilityMode (example to `http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
836. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
Control | 0..1
Binding | For example codes, see LanguageAbilityProficiency (example to `http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
838. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
840. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
842. 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
844. 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
846. 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()`)
848. 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
850. 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
852. 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
854. 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`
856. 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
858. 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
860. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ORG`
862. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
864. 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
Must Support | true
866. 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
Must Support | true
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()))
868. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
870. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
872. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
874. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
876. ClinicalDocument.author
Short | The author element represents the creator of the clinical document. The author may be a device or a person.
Comments | SHALL contain at least one [1..*] author (CONF:4537-5444).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
878. 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
880. 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
882. 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()`)
884. 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
886. 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
888. 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
890. 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`
892. 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
894. 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
896. 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`
898. 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`
900. ClinicalDocument.author.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
902. ClinicalDocument.author.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
904. ClinicalDocument.author.assignedAuthor
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-us-code: SHOULD contain code (`code.exists()`)
906. 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
908. 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
910. 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()`)
912. 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
914. 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
916. 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
918. 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`
920. 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
922. 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
924. ClinicalDocument.author.assignedAuthor.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
926. ClinicalDocument.author.assignedAuthor.id
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
928. 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`.
930. ClinicalDocument.author.assignedAuthor.code
Short | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).
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
Must Support | true
932. 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
934. 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
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element 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
936. 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
938. 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
940. 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
942. 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
944. 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`.
946. 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`.
948. 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
950. 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
952. 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
954. ClinicalDocument.author.assignedAuthor.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
956. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
958. 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
960. 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.
962. 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
964. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
966. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | MAY contain assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
968. 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
970. 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
972. 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()`)
974. 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
976. 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
978. 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
980. 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`
982. 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
984. 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
986. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
988. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
990. ClinicalDocument.author.assignedAuthor.assignedPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
Comments | Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
992. 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`.
994. 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`.
996. 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
998. 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
1000. 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()`)
1002. 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
1004. 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
1006. 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
1008. 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`
1010. 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
1012. 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
1014. 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`
1016. 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`
1018. 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`.
1020. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | MAY contain assignedAuthoringDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
1022. 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
1024. 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
1026. 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()`)
1028. 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
1030. 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
1032. 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
1034. 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`
1036. 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
1038. 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
1040. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassDevice (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `DEV`
1042. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1044. 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
1046. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..1
Binding | For example codes, see Manufacturer Model Name Example (example to `http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
Must Support | true
1048. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..1
Binding | For example codes, see Software Name Example (example to `http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
Must Support | true
1050. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
1052. ClinicalDocument.author.assignedAuthor.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1054. ClinicalDocument.dataEnterer
Short | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
1056. 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
1058. 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
1060. 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()`)
1062. 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
1064. 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
1066. 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
1068. 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`
1070. 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
1072. 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
1074. 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`
1076. 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`
1078. ClinicalDocument.dataEnterer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
1080. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Must Support | true
1082. 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
1084. 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
1086. 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()`)
1088. 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
1090. 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
1092. 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
1094. 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`
1096. 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
1098. 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
1100. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1102. 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
1104. 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`.
1106. ClinicalDocument.dataEnterer.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32173).
Control | 0..1
Binding | For example codes, see CDARoleCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1108. ClinicalDocument.dataEnterer.assignedEntity.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1110. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1112. 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
1114. 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.
1116. 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
1118. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1120. 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
Must Support | true
1122. 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
1124. 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
1126. 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()`)
1128. 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
1130. 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
1132. 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
1134. 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`
1136. 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
1138. 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
1140. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1142. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1144. 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
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1146. 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`.
1148. 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`.
1150. 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
1152. 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
1154. 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()`)
1156. 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
1158. 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
1160. 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
1162. 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`
1164. 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
1166. 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
1168. 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`
1170. 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`
1172. 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`.
1174. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1176. 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`.
1178. 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`.
1180. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This element introduces a set of slices on `ClinicalDocument.informant`. The slices areUnordered and Open, and can be differentiated using the following discriminators: exists @ relatedEntity exists @ assignedEntity
1182. ClinicalDocument.informant:provider
Slice Name | provider
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
1184. 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
1186. 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
1188. 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()`)
1190. 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
1192. 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
1194. 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
1196. 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`
1198. 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
1200. 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
1202. 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`
1204. 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`
1206. 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
1208. 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
1210. 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
1212. 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()`)
1214. 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
1216. 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
1218. 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
1220. 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`
1222. 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
1224. 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
1226. ClinicalDocument.informant:provider.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1228. 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
1230. 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`.
1232. ClinicalDocument.informant:provider.assignedEntity.code
Control | 0..1
Binding | For example codes, see NUCCProviderCodes (example to `http://terminology.hl7.org/ValueSet/v3-NUCCProviderCodes` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1234. ClinicalDocument.informant:provider.assignedEntity.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1236. ClinicalDocument.informant:provider.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1238. 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
Must Support | true
1240. 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
1242. 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
1244. 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()`)
1246. 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
1248. 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
1250. 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
1252. 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`
1254. 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
1256. 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
1258. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1260. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1262. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
Comments | Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1264. 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`.
1266. 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`.
1268. 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
1270. 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
1272. 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()`)
1274. 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
1276. 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
1278. 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
1280. 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`
1282. 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
1284. 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
1286. 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`
1288. 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`
1290. 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`.
1292. ClinicalDocument.informant:provider.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1294. 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`.
1296. 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`.
1298. ClinicalDocument.informant:provider.relatedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1300. ClinicalDocument.informant:non-provider
Slice Name | non-provider
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
1302. 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
1304. 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
1306. 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()`)
1308. 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
1310. 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
1312. 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
1314. 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`
1316. 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
1318. 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
1320. 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`
1322. 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`
1324. ClinicalDocument.informant:non-provider.assignedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1326. ClinicalDocument.informant:non-provider.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
Must Support | true
1328. ClinicalDocument.custodian
Short | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, 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.
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
Must Support | true
1330. 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
1332. 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
1334. 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()`)
1336. 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
1338. 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
1340. 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
1342. 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`
1344. 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
1346. 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
1348. 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`
1350. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
1352. 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
1354. 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
1356. 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()`)
1358. 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
1360. 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
1362. 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
1364. 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`
1366. 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
1368. 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
1370. ClinicalDocument.custodian.assignedCustodian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1372. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
1374. 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
1376. 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
1378. 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()`)
1380. 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
1382. 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
1384. 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
1386. 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`
1388. 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
1390. 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
1392. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ORG`
1394. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1396. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1398. 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
Must Support | true
1400. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1402. 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
1404. 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.
1406. 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
1408. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1410. 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`.
1412. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1414. ClinicalDocument.informationRecipient
Short | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart.
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
1416. 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
1418. 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
1420. 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()`)
1422. 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
1424. 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
1426. 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
1428. 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`
1430. 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
1432. 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
1434. 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`
1436. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
1438. 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
1440. 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
1442. 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()`)
1444. 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
1446. 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
1448. 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
1450. 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`
1452. 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
1454. 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
1456. 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`
1458. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1460. 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`.
1462. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1464. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1466. 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
1468. 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
1470. 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
1472. 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()`)
1474. 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
1476. 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
1478. 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
1480. 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`
1482. 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
1484. 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
1486. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1488. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1490. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
Definition | A name associated with the person.
Short | A name associated with the person
Comments | Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1492. 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`.
1494. 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`.
1496. 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
1498. 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
1500. 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()`)
1502. 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
1504. 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
1506. 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
1508. 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`
1510. 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
1512. 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
1514. 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`
1516. 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`
1518. 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`.
1520. 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
1522. 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
1524. 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
1526. 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()`)
1528. 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
1530. 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
1532. 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
1534. 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`
1536. 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
1538. 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
1540. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ORG`
1542. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1544. 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
1546. 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()))
1548. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1550. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1552. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1554. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
1556. ClinicalDocument.legalAuthenticator
Short | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical 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. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Comments | SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Must Support | true
1558. 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
1560. 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
1562. 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()`)
1564. 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
1566. 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
1568. 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
1570. 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`
1572. 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
1574. 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
1576. 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`
1578. 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`
1580. ClinicalDocument.legalAuthenticator.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
1582. 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'`)
1584. 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
1586. 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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | `S`
1588. 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
1590. 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
1592. 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
1594. 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
1596. 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`.
1598. 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`.
1600. 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
1602. 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
1604. 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
1606. 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`.
1608. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1610. 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
1612. 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
1614. 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()`)
1616. 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
1618. 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
1620. 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
1622. 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`
1624. 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
1626. 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
1628. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1630. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1632. 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`.
1634. ClinicalDocument.legalAuthenticator.assignedEntity.code
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
1636. 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
Must Support | true
Invariants | should-country: SHOULD contain country ()
1638. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1640. 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
1642. 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.
1644. 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
1646. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1648. 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
Must Support | true
1650. 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
1652. 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
1654. 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()`)
1656. 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
1658. 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
1660. 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
1662. 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`
1664. 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
1666. 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
1668. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1670. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1672. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
Comments | Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1674. 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`.
1676. 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`.
1678. 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
1680. 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
1682. 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()`)
1684. 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
1686. 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
1688. 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
1690. 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`
1692. 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
1694. 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
1696. 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`
1698. 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`
1700. 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`.
1702. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1704. 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`.
1706. 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`.
1708. ClinicalDocument.authenticator
Short | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
1710. 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
1712. 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
1714. 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()`)
1716. 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
1718. 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
1720. 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
1722. 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`
1724. 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
1726. 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
1728. 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`
1730. ClinicalDocument.authenticator.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
1732. 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'`)
1734. 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
1736. 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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | `S`
1738. 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
1740. 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
1742. 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
1744. 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
1746. 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`.
1748. 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`.
1750. 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
1752. 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
1754. 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
1756. 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`.
1758. ClinicalDocument.authenticator.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1760. 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
1762. 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
1764. 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()`)
1766. 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
1768. 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
1770. 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
1772. 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`
1774. 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
1776. 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
1778. ClinicalDocument.authenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1780. ClinicalDocument.authenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1782. 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`.
1784. ClinicalDocument.authenticator.assignedEntity.code
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
1786. 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
1788. 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
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element 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
1790. 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
1792. 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
1794. 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
1796. 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
1798. 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`.
1800. 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`.
1802. 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
1804. 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
1806. 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
1808. ClinicalDocument.authenticator.assignedEntity.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1810. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1812. 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
1814. 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.
1816. 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
1818. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1820. 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
Must Support | true
1822. 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
1824. 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
1826. 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()`)
1828. 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
1830. 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
1832. 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
1834. 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`
1836. 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
1838. 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
1840. ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1842. ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1844. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
Comments | Person may have multiple names with different uses or applicable periods.
Control | 10..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN HumanName
Is Modifier | false
Must Support | true
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1846. 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`.
1848. 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`.
1850. 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
1852. 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
1854. 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()`)
1856. 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
1858. 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
1860. 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
1862. 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`
1864. 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
1866. 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
1868. 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`
1870. 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`
1872. 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`.
1874. ClinicalDocument.authenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1876. 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`.
1878. 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`.
1880. ClinicalDocument.participant
Short | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others 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 | SHOULD contain zero or more [0..*] RelatedPerson participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). (`associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()`)
1882. 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
1884. 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
1886. 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()`)
1888. 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
1890. 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
1892. 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
1894. 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`
1896. 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
1898. 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
1900. ClinicalDocument.participant.typeCode
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.
1902. 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`
1904. ClinicalDocument.participant.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1906. 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
Must Support | true
1908. ClinicalDocument.participant.associatedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
1910. 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:4537-9952).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
1912. 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
1914. 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
1916. 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()`)
1918. 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
1920. 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
1922. 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
1924. 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`
1926. 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
1928. 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
1930. 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`
1932. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
1934. 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
1936. 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
1938. 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()`)
1940. 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
1942. 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
1944. 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
1946. 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`
1948. 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
1950. 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
1952. 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`
1954. 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`
1956. ClinicalDocument.inFulfillmentOf.order.id
Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
1958. ClinicalDocument.inFulfillmentOf.order.code
Control | 0..1
Binding | For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1960. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1962. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
1964. 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
1966. 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
1968. 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()`)
1970. 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
1972. 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
1974. 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
1976. 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`
1978. 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
1980. 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
1982. 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`
1984. 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:4537-14836).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
Invariants | should-us-performer: SHOULD contain performer (`performer.exists()`)
1986. 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
1988. 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
1990. 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()`)
1992. 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
1994. 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
1996. 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
1998. 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`
2000. 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
2002. 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
2004. 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`
2006. 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`
2008. ClinicalDocument.documentationOf.serviceEvent.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2010. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2012. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Must Support | true
2014. 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
2016. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
Control | 0..1
Type | 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.
2018. 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`
2020. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Must Support | true
Label | Low Boundary
2022. 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
2024. 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
2026. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
2028. ClinicalDocument.documentationOf.serviceEvent.performer
Short | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
Must Support | true
2030. 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
2032. 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
2034. 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()`)
2036. 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
2038. 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
2040. 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
2042. 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`
2044. 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
2046. 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
2048. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer (required to `http://terminology.hl7.org/ValueSet/v3-xServiceEventPerformer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
2050. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Must Support | true
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
2052. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Must Support | true
2054. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-us-code: SHOULD contain code (`code.exists()`)
2056. 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
2058. 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
2060. 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()`)
2062. 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
2064. 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
2066. 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
2068. 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`
2070. 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
2072. 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
2074. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
2076. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2078. 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`.
2080. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
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
2082. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
2084. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
2086. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
2088. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2090. 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`.
2092. 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`.
2094. ClinicalDocument.relatedDocument
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
2096. 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
2098. 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
2100. 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
2102. 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()`)
2104. 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
2106. 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
2108. 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
2110. 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`
2112. 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
2114. 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
2116. ClinicalDocument.authorization.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipAuthorizedBy (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may 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`
2118. 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
Must Support | true
2120. 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
2122. 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
2124. 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()`)
2126. 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
2128. 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
2130. 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
2132. 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`
2134. 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
2136. 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
2138. 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`
2140. 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`
2142. 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
2144. 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 v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2146. 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 (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Must Support | true
2148. 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
2150. 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`
2152. 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
2154. 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
2156. 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
2158. 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
2160. 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`.
2162. 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`.
2164. 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
2166. 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
2168. 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
2170. ClinicalDocument.componentOf
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
Must Support | true
2172. 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
2174. 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
2176. 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()`)
2178. 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
2180. 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
2182. 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
2184. 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`
2186. 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
2188. 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
2190. ClinicalDocument.componentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `COMP`
2192. 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()`)
2194. 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
2196. 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
2198. 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()`)
2200. 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
2202. 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
2204. 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
2206. 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`
2208. 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
2210. 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
2212. 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`
2214. 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`
2216. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
2218. ClinicalDocument.componentOf.encompassingEncounter.code
Control | 0..1
Binding | For example codes, see ActEncounterCode (example to `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2220. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Must Support | true
2222. 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`.
2224. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control | 0..1
Binding | For example codes, see USEncounterDischargeDisposition (example to `http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2226. 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.
Short | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care.
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
Must Support | true
Invariants | 1198-8348: The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). (`assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()`)
2228. 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
2230. 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
2232. 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()`)
2234. 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
2236. 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
2238. 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
2240. 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`
2242. 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
2244. 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
2246. 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`
2248. 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
Must Support | true
Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (`assignedPerson.exists() or representedOrganization.exists()`)
2250. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Short | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care.
Comments | This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8342).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
Invariants | 1198-8348: The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). (`assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()`)
2252. 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.
Comments | This encompassingEncounter MAY contain zero or one [0..1] location (CONF:1198-8344).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2254. 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
2256. 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
2258. 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()`)
2260. 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
2262. 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
2264. 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
2266. 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`
2268. 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
2270. 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
2272. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetLocation (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `LOC`
2274. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
2276. ClinicalDocument.component
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component

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`.
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 (`AssociatedEntity.associatedPerson.exists()`)
2. ClinicalDocument.classCode
Control | 1..?
Must Support | true
4. ClinicalDocument.realmCode
Comments | SHALL contain at least one [1..1] realmCode=" ". realmCode Should be UV
Control | 1..1
6. ClinicalDocument.realmCode.code
Control | 1..?
Must Support | true
Invariants | ihe-pcc-realmCode-1: If realmCode is present it SHOULD be UV (`realmCode.code.exists() implies realmCode.code.exists(value=#UV)`)
8. ClinicalDocument.typeId
Control | 1..?
Must Support | true
10. ClinicalDocument.typeId.root
Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).
12. ClinicalDocument.typeId.extension
Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
14. ClinicalDocument.templateId
Control | 1..?
Must Support | true
Invariants | ihe-pcc-realmCode-2: If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 (`realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)`)
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
16. ClinicalDocument.templateId:uv-realm
Slice Name | uv-realm
Control | 1..1
Must Support | true
18. ClinicalDocument.templateId:uv-realm.root
Control | 1..?
Pattern Value | `1.3.6.1.4.1.19376.1.5.3.1.1.1`
20. ClinicalDocument.templateId:us-realm
Slice Name | us-realm
Control | 0..1
22. ClinicalDocument.templateId:us-realm.root
Control | 1..?
Pattern Value | `2.16.840.1.113883.10.20.22.1.1`
24. ClinicalDocument.templateId:us-realm.extension
Control | 1..?
Pattern Value | `2024-05-01`
26. ClinicalDocument.id
Short | **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363). The uniqueId can be formatted using the following XPath expression, where $docID in the expression below represents the identifier. concat($docID/@root, $docID/@extension)
Must Support | true
28. ClinicalDocument.sdtcCategory
Short | Used to categorize the document type..
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
30. ClinicalDocument.sdtcCategory:documentType
Slice Name | documentType
Control | 0..*
Must Support | true
32. ClinicalDocument.sdtcCategory:documentType.code
Control | 1..?
Must Support | true
34. ClinicalDocument.sdtcCategory:documentType.codeSystem
Control | 1..?
Must Support | true
Pattern Value | `2.16.840.1.113883.6.1`
36. ClinicalDocument.sdtcCategory:documentType.codeSystemName
Control | 1..?
Must Support | true
Pattern Value | `LOINC`
38. ClinicalDocument.sdtcCategory:documentType.displayName
Control | 1..?
Must Support | true
40. ClinicalDocument.code
Short | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
42. ClinicalDocument.code.nullFlavor
Must Support | true
44. ClinicalDocument.code.code
Comments | The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.
Control | 1..?
Must Support | true
46. ClinicalDocument.code.codeSystem
Control | 1..?
Must Support | true
Pattern Value | `2.16.840.1.113883.6.1`
48. ClinicalDocument.code.codeSystemName
Control | 1..?
Must Support | true
Pattern Value | `LOINC`
50. ClinicalDocument.code.displayName
Control | 1..?
Must Support | true
52. 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..?
54. ClinicalDocument.effectiveTime
Comments | Times specified in clinical documents may be specified with a precision in fractional sections, and may contain a time zone offset. In the XDS Metadata, it can be precise to the second, and is always given in UTC, so the timezone offset if present must be added to the current time to obtain the UTC time.
Must Support | true
56. ClinicalDocument.confidentialityCode
58. ClinicalDocument.confidentialityCode.nullFlavor
Control | 0..0
60. ClinicalDocument.confidentialityCode.code
Binding | The codes SHOULD be taken from Confidentiality (preferred to `http://terminology.hl7.org/ValueSet/v3-Confidentiality` )
Must Support | true
62. ClinicalDocument.languageCode
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..?
Must Support | true
64. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
66. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
68. ClinicalDocument.recordTarget
Short | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
Must Support | true
70. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
Must Support | true
72. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
Must Support | true
74. ClinicalDocument.recordTarget.patientRole.addr
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
76. ClinicalDocument.recordTarget.patientRole.telecom
Control | 1..?
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
78. ClinicalDocument.recordTarget.patientRole.telecom.use
Control | 1..?
Must Support | true
80. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..?
Must Support | true
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-us-addr: SHOULD contain addr (`addr.exists()`) should-maritalStatusCode: SHOULD contain maritalStatusCode (`maritalStatusCode.exists()`) should-us-languageCommunication: SHOULD contain languageCommunication (`languageCommunication.exists()`)
82. ClinicalDocument.recordTarget.patientRole.patient.name
Control | 1..?
Must Support | true
Invariants | iti-pdqm-patname: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
84. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Control | 1..?
Must Support | true
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`)
86. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | Date of Death
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`)
88. ClinicalDocument.recordTarget.patientRole.patient.guardian
Must Support | true
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()`)
90. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
Binding | The codes SHOULD be taken from PersonalAndLegalRelationshipRoleType (preferred to `http://terminology.hl7.org/ValueSet/v3-PersonalAndLegalRelationshipRoleType` )
Must Support | true
92. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
Must Support | true
Invariants | should-country: SHOULD contain country ()
94. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
96. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use
Control | 1..?
Must Support | true
98. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
Control | 1..?
Must Support | true
100. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
Control | 1..?
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
102. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments | This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).
104. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).
106. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
108. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
110. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
Binding | The codes SHALL be taken from Country2 (required to `http://terminology.hl7.org/ValueSet/v3-Country2` )
112. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Must Support | true
Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (`proficiencyLevelCode.exists()`) should-preferenceInd: SHOULD contain preferenceInd (`preferenceInd.exists()`)
114. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Control | 1..?
Binding | The codes SHALL be taken from Languages (required to `http://terminology.hl7.org/ValueSet/Languages` )
Must Support | true
116. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).
118. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).
Control | 1..?
Must Support | true
120. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).
Control | 1..?
Must Support | true
122. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Control | 1..?
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
124. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
126. ClinicalDocument.author
Short | The author element represents the creator of the clinical document. The author may be a device or a person.
Comments | SHALL contain at least one [1..*] author (CONF:4537-5444).
128. ClinicalDocument.author.assignedAuthor
Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). (`(assignedPerson | assignedAuthoringDevice).count() = 1`) should-us-code: SHOULD contain code (`code.exists()`)
130. ClinicalDocument.author.assignedAuthor.id
Must Support | true
132. ClinicalDocument.author.assignedAuthor.code
Short | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).
Must Support | true
134. ClinicalDocument.author.assignedAuthor.code.nullFlavor
Control | 0..0
136. ClinicalDocument.author.assignedAuthor.code.code
Control | 1..?
138. ClinicalDocument.author.assignedAuthor.addr
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
140. ClinicalDocument.author.assignedAuthor.telecom
Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).
Control | 1..?
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
142. ClinicalDocument.author.assignedAuthor.telecom.use
Must Support | true
144. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | MAY contain assignedPerson
146. ClinicalDocument.author.assignedAuthor.assignedPerson.name
Control | 1..?
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
148. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | MAY contain assignedAuthoringDevice
150. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..?
Must Support | true
152. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..?
Must Support | true
154. ClinicalDocument.dataEnterer
Short | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).
156. ClinicalDocument.dataEnterer.time
Must Support | true
158. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).
Must Support | true
160. ClinicalDocument.dataEnterer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).
162. ClinicalDocument.dataEnterer.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32173).
164. ClinicalDocument.dataEnterer.assignedEntity.addr
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
166. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).
Control | 1..?
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
168. ClinicalDocument.dataEnterer.assignedEntity.telecom.use
Must Support | true
170. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).
Control | 1..?
Must Support | true
172. 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..?
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
174. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
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
176. ClinicalDocument.informant:provider
Slice Name | provider
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..*
178. ClinicalDocument.informant:provider.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).
Control | 1..?
180. 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).
182. ClinicalDocument.informant:provider.assignedEntity.code
Binding | For example codes, see NUCCProviderCodes (example to `http://terminology.hl7.org/ValueSet/v3-NUCCProviderCodes` )
184. ClinicalDocument.informant:provider.assignedEntity.addr
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
186. ClinicalDocument.informant:provider.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).
Control | 1..?
Must Support | true
188. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name
Control | 1..?
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
190. ClinicalDocument.informant:provider.relatedEntity
Control | 0..0
192. ClinicalDocument.informant:non-provider
Slice Name | non-provider
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..*
194. ClinicalDocument.informant:non-provider.assignedEntity
Control | 0..0
196. ClinicalDocument.informant:non-provider.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..?
Must Support | true
198. ClinicalDocument.custodian
Short | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, 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.
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
Must Support | true
200. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
202. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
204. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
206. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).
Control | 1..?
Must Support | true
208. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).
Control | 1..?
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
210. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use
Must Support | true
212. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom
Short | The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization.
214. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
216. ClinicalDocument.informationRecipient
Short | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart.
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).
218. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).
220. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).
222. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).
224. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
Control | 1..?
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
226. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).
228. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).
Control | 1..1
230. ClinicalDocument.legalAuthenticator
Short | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical 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. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Comments | SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).
Must Support | true
232. ClinicalDocument.legalAuthenticator.time
Must Support | true
234. ClinicalDocument.legalAuthenticator.signatureCode
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).
236. ClinicalDocument.legalAuthenticator.signatureCode.code
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..?
Must Support | true
Pattern Value | `S`
238. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Short | The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. 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).
240. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).
242. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).
244. 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..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
246. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).
Control | 1..?
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
248. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use
Must Support | true
250. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).
Control | 1..?
Must Support | true
252. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
Control | 1..?
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
254. ClinicalDocument.authenticator
Short | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
256. ClinicalDocument.authenticator.time
Must Support | true
258. ClinicalDocument.authenticator.signatureCode
Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).
260. ClinicalDocument.authenticator.signatureCode.code
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..?
Must Support | true
Pattern Value | `S`
262. ClinicalDocument.authenticator.sdtcSignatureText
Short | The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. 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).
264. ClinicalDocument.authenticator.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
266. ClinicalDocument.authenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
268. ClinicalDocument.authenticator.assignedEntity.code
270. ClinicalDocument.authenticator.assignedEntity.code.code
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).
272. ClinicalDocument.authenticator.assignedEntity.addr
Control | 1..?
Must Support | true
Invariants | should-country: SHOULD contain country ()
274. ClinicalDocument.authenticator.assignedEntity.telecom
Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).
Control | 1..?
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
276. ClinicalDocument.authenticator.assignedEntity.telecom.use
Must Support | true
278. ClinicalDocument.authenticator.assignedEntity.assignedPerson
Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).
Control | 1..?
Must Support | true
280. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name
Control | 1..?
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
282. ClinicalDocument.participant
Short | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others 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 | SHOULD contain zero or more [0..*] RelatedPerson participant
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). (`associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()`)
284. ClinicalDocument.participant.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-10004).
Must Support | true
286. 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:4537-9952).
288. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).
290. ClinicalDocument.inFulfillmentOf.order.id
Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954).
Must Support | true
292. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835).
294. 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:4537-14836).
Invariants | should-us-performer: SHOULD contain performer (`performer.exists()`)
296. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Control | 1..?
Must Support | true
298. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..?
Must Support | true
300. ClinicalDocument.documentationOf.serviceEvent.performer
Short | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).
Must Support | true
302. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).
Must Support | true
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
304. ClinicalDocument.documentationOf.serviceEvent.performer.time
Must Support | true
306. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).
Invariants | should-us-code: SHOULD contain code (`code.exists()`)
308. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).
310. 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
312. ClinicalDocument.authorization.consent
Comments | SHALL contain exactly one [1..1] consent (CONF:4537-16793).
Must Support | true
314. ClinicalDocument.authorization.consent.id
Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794).
316. 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).
318. ClinicalDocument.authorization.consent.statusCode
Comments | This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).
Must Support | true
320. ClinicalDocument.authorization.consent.statusCode.code
Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).
322. ClinicalDocument.componentOf
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).
Must Support | true
324. ClinicalDocument.componentOf.encompassingEncounter
Comments | The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).
Invariants | should-responsibleParty: SHOULD contain responsibleParty (`responsibleParty.exists()`)
326. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..1
Must Support | true
328. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Must Support | true
330. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Short | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care.
Comments | This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).
Must Support | true
Invariants | 1198-8348: The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). (`assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()`)
332. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Comments | The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).
Must Support | true
Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (`assignedPerson.exists() or representedOrganization.exists()`)
334. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Short | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care.
Comments | This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8342).
Invariants | 1198-8348: The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). (`assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()`)
336. ClinicalDocument.componentOf.encompassingEncounter.location
Comments | This encompassingEncounter MAY contain zero or one [0..1] location (CONF:1198-8344).
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 (`AssociatedEntity.associatedPerson.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 | 1..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
Must Support | true
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 at least one [1..1] realmCode=" ". realmCode Should be UV
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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Invariants | ihe-pcc-realmCode-1: If realmCode is present it SHOULD be UV (`realmCode.code.exists() implies realmCode.code.exists(value=#UV)`)
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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
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 | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
Invariants | ihe-pcc-realmCode-2: If realmCode is US, then the templateId SHALL be both 1.3.6.1.4.1.19376.1.5.3.1.1.1 and 2.16.840.1.113883.10.20.3 (`realmCode.code.exists(value=#US) implies templateId.us-realm.root.exists(value = 2.16.840.1.113883.10.20.22.1.1)`)
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:uv-realm
Slice Name | uv-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
Must Support | true
48. ClinicalDocument.templateId:uv-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:uv-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:uv-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:uv-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 | `1.3.6.1.4.1.19376.1.5.3.1.1.1`
56. ClinicalDocument.templateId:uv-realm.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
58. 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 | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
60. 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
62. 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
64. 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
66. 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`
68. 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`
70. ClinicalDocument.id
Short | **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
Comments | SHALL contain exactly one [1..1] id (CONF:4537-5363). The uniqueId can be formatted using the following XPath expression, where $docID in the expression below represents the identifier. concat($docID/@root, $docID/@extension)
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
72. ClinicalDocument.sdtcCategory
Short | Used to categorize the document type..
Control | 0..*
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
74. ClinicalDocument.sdtcCategory:documentType
Slice Name | documentType
Control | 0..*
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`.
76. ClinicalDocument.sdtcCategory:documentType.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
78. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
80. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
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`
82. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
Pattern Value | `LOINC`
84. ClinicalDocument.sdtcCategory:documentType.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
86. ClinicalDocument.sdtcCategory:documentType.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
88. ClinicalDocument.sdtcCategory:documentType.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`.
90. ClinicalDocument.sdtcCategory:documentType.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`.
92. ClinicalDocument.sdtcCategory:documentType.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
94. ClinicalDocument.sdtcCategory:documentType.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
96. ClinicalDocument.sdtcCategory:documentType.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
98. ClinicalDocument.code
Short | **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
Comments | SHALL contain exactly one [1..1] code (CONF:4537-5253).
Control | 1..1
Binding | For example codes, see FHIRDocumentTypeCodes (example to `http://hl7.org/fhir/ValueSet/doc-typecodes` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
100. ClinicalDocument.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
102. ClinicalDocument.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments | The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
104. 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
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
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`
106. ClinicalDocument.code.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
Pattern Value | `LOINC`
108. 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
110. ClinicalDocument.code.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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
112. 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`.
114. 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`.
116. 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
118. 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
120. 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
122. 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
124. 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.
Control | 0..1
Binding | The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
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`.
126. ClinicalDocument.effectiveTime
Comments | Times specified in clinical documents may be specified with a precision in fractional sections, and may contain a time zone offset. In the XDS Metadata, it can be precise to the second, and is always given in UTC, so the timezone offset if present must be added to the current time to obtain the UTC time.
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
128. ClinicalDocument.confidentialityCode
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
130. 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
132. 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 | 0..1
Binding | The codes SHOULD be taken from Confidentiality (preferred to `http://terminology.hl7.org/ValueSet/v3-Confidentiality` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
134. 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
136. 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
138. 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
140. 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
142. 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`.
144. 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`.
146. 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
148. 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
150. 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
152. ClinicalDocument.languageCode
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
Must Support | true
154. ClinicalDocument.setId
Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
156. ClinicalDocument.versionNumber
Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
158. ClinicalDocument.copyTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
160. ClinicalDocument.recordTarget
Short | The recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element
Comments | SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
Must Support | true
162. 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
164. 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
166. 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()`)
168. 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
170. 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
172. 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
174. 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`
176. 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
178. 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
180. 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`
182. 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`
184. ClinicalDocument.recordTarget.patientRole
Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
Must Support | true
186. 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
188. 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
190. 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()`)
192. 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
194. 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
196. 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
198. 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`
200. 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
202. 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
204. ClinicalDocument.recordTarget.patientRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassRelationshipFormal (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PAT`
206. ClinicalDocument.recordTarget.patientRole.id
Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
208. 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`.
210. ClinicalDocument.recordTarget.patientRole.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
212. ClinicalDocument.recordTarget.patientRole.telecom
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
214. 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
216. 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.
218. 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
220. 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.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
222. ClinicalDocument.recordTarget.patientRole.patient
Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Patient
Must Support | true
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-us-addr: SHOULD contain addr (`addr.exists()`) should-maritalStatusCode: SHOULD contain maritalStatusCode (`maritalStatusCode.exists()`) should-us-languageCommunication: SHOULD contain languageCommunication (`languageCommunication.exists()`)
224. 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
226. 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
228. 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()`)
230. 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
232. 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
234. 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
236. 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`
238. 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
240. 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
242. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
244. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
246. ClinicalDocument.recordTarget.patientRole.patient.id
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
248. ClinicalDocument.recordTarget.patientRole.patient.name
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
Must Support | true
Invariants | iti-pdqm-patname: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
250. 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`.
252. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Control | 0..1
Binding | For example codes, see AdministrativeGender (example to `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
254. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
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`)
256. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
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`.
258. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short | Date of Death
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`)
260. 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`.
262. 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`.
264. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
Control | 0..1
Binding | For example codes, see MaritalStatus (example to `http://terminology.hl7.org/ValueSet/v3-MaritalStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
266. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
Control | 0..1
Binding | For example codes, see ReligiousAffiliation (example to `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
268. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Control | 0..1
Binding | For example codes, see Race (example to `http://terminology.hl7.org/ValueSet/v3-Race` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
270. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Control | 0..*
Binding | For example codes, see Race (example to `http://terminology.hl7.org/ValueSet/v3-Race` )
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`.
272. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Control | 0..1
Binding | For example codes, see Ethnicity (example to `http://terminology.hl7.org/ValueSet/v3-Ethnicity` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
274. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Control | 0..*
Binding | For example codes, see Ethnicity (example to `http://terminology.hl7.org/ValueSet/v3-Ethnicity` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`ethnicGroupCode`.
276. ClinicalDocument.recordTarget.patientRole.patient.guardian
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian
Must Support | true
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()`)
278. 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
280. 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
282. 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()`)
284. 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
286. 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
288. 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
290. 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`
292. 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
294. 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
296. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAgent (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `GUARD`
298. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
300. 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`.
302. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
Control | 0..1
Binding | The codes SHOULD be taken from PersonalAndLegalRelationshipRoleType (preferred to `http://terminology.hl7.org/ValueSet/v3-PersonalAndLegalRelationshipRoleType` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Must Support | true
304. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
306. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
308. 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
310. 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.
312. 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
314. 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.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
316. 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
Must Support | true
318. 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
320. 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
322. 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()`)
324. 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
326. 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
328. 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
330. 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`
332. 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
334. 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
336. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
338. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
340. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
342. 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`.
344. 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`.
346. 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
348. 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
350. 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()`)
352. 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
354. 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
356. 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
358. 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`
360. 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
362. 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
364. 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`
366. 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`
368. 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`.
370. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
372. 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
374. 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
376. 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
378. 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()`)
380. 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
382. 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
384. 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
386. 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`
388. 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
390. 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
392. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassPassive (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassPassive` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `BIRTHPL`
394. 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
396. 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
398. 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
400. 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()`)
402. 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
404. 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
406. 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
408. 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`
410. 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
412. 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
414. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassPlace (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassPlace` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PLC`
416. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
418. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
420. 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
Must Support | true
Invariants | should-country: SHOULD contain country ()
422. 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
424. 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
426. 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
428. 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`)
430. 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`)
432. 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
434. 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`
436. 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`
438. 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
440. 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.
442. 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`
444. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
Definition | Country
Control | 0..1
Binding | The codes SHALL be taken from Country2 (required to `http://terminology.hl7.org/ValueSet/v3-Country2` )
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`)
446. 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
448. 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`
450. 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`
452. 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
454. 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.
456. 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`
458. 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`)
460. 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
462. 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`
464. 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`
466. 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
468. 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.
470. 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`
472. 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`)
474. 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
476. 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`
478. 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`
480. 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
482. 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.
484. 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`
486. 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`)
488. 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
490. 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`
492. 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`
494. 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
496. 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.
498. 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`
500. 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`)
502. 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
504. 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`
506. 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`
508. 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
510. 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.
512. 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`
514. 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`)
516. 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
518. 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`
520. 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`
522. 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
524. 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.
526. 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`
528. 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`)
530. 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
532. 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`
534. 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`
536. 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
538. 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.
540. 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`
542. 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`)
544. 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
546. 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`
548. 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`
550. 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
552. 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.
554. 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`
556. 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`)
558. 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
560. 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`
562. 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`
564. 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
566. 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.
568. 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`
570. 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`)
572. 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
574. 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`
576. 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`
578. 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
580. 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.
582. 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`
584. 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`)
586. 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
588. 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`
590. 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`
592. 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
594. 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.
596. 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`
598. 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`)
600. 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
602. 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`
604. 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`
606. 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
608. 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.
610. 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`
612. 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`)
614. 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
616. 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`
618. 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`
620. 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
622. 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.
624. 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`
626. 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`)
628. 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
630. 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`
632. 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`
634. 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
636. 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.
638. 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`
640. 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`)
642. 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
644. 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`
646. 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`
648. 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
650. 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.
652. 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`
654. 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`)
656. 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
658. 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`
660. 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`
662. 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
664. 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.
666. 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`
668. 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`)
670. 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
672. 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`
674. 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`
676. 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
678. 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.
680. 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`
682. 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`)
684. 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
686. 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`
688. 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`
690. 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
692. 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.
694. 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`
696. 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`)
698. 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
700. 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`
702. 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`
704. 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
706. 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.
708. 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`
710. 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`)
712. 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
714. 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`
716. 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`
718. 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
720. 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.
722. 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`
724. 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`)
726. 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
728. 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`
730. 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`
732. 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
734. 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.
736. 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`
738. 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`)
740. 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
742. 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`
744. 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`
746. 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
748. 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.
750. 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`
752. 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`)
754. 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
756. 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`
758. 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`
760. 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
762. 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.
764. 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`
766. 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`)
768. 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
770. 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`
772. 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`
774. 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
776. 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.
778. 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`
780. 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`)
782. 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
784. 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`
786. 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`
788. 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
790. 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.
792. 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`
794. 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`)
796. 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
798. 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`
800. 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`
802. 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
804. 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.
806. 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`
808. 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.
810. 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
812. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
Must Support | true
Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (`proficiencyLevelCode.exists()`) should-preferenceInd: SHOULD contain preferenceInd (`preferenceInd.exists()`)
814. 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
816. 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
818. 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()`)
820. 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
822. 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
824. 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
826. 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`
828. 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
830. 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
832. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Control | 1..1
Binding | The codes SHALL be taken from Languages (required to `http://terminology.hl7.org/ValueSet/Languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Must Support | true
834. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode
Control | 0..1
Binding | For example codes, see LanguageAbilityMode (example to `http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
836. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
Control | 0..1
Binding | For example codes, see LanguageAbilityProficiency (example to `http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
838. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
840. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
842. 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
844. 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
846. 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()`)
848. 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
850. 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
852. 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
854. 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`
856. 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
858. 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
860. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ORG`
862. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
864. 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
Must Support | true
866. 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
Must Support | true
868. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
870. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
872. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
874. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
876. ClinicalDocument.author
Short | The author element represents the creator of the clinical document. The author may be a device or a person.
Comments | SHALL contain at least one [1..*] author (CONF:4537-5444).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
878. 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
880. 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
882. 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()`)
884. 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
886. 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
888. 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
890. 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`
892. 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
894. 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
896. 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`
898. 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`
900. ClinicalDocument.author.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
902. ClinicalDocument.author.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
904. ClinicalDocument.author.assignedAuthor
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-us-code: SHOULD contain code (`code.exists()`)
906. 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
908. 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
910. 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()`)
912. 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
914. 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
916. 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
918. 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`
920. 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
922. 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
924. ClinicalDocument.author.assignedAuthor.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
926. ClinicalDocument.author.assignedAuthor.id
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
928. 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`.
930. ClinicalDocument.author.assignedAuthor.code
Short | Only if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.
Comments | This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).
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
Must Support | true
932. 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
934. 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
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element 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
936. 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
938. 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
940. 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
942. 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
944. 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`.
946. 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`.
948. 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
950. 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
952. 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
954. ClinicalDocument.author.assignedAuthor.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
956. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
958. 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
960. 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.
962. 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
964. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
966. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments | MAY contain assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
968. 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
970. 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
972. 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()`)
974. 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
976. 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
978. 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
980. 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`
982. 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
984. 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
986. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
988. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
990. ClinicalDocument.author.assignedAuthor.assignedPerson.name
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
992. 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`.
994. 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`.
996. 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
998. 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
1000. 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()`)
1002. 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
1004. 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
1006. 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
1008. 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`
1010. 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
1012. 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
1014. 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`
1016. 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`
1018. 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`.
1020. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments | MAY contain assignedAuthoringDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
1022. 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
1024. 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
1026. 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()`)
1028. 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
1030. 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
1032. 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
1034. 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`
1036. 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
1038. 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
1040. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassDevice (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassDevice` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `DEV`
1042. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1044. 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
1046. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).
Control | 1..1
Binding | For example codes, see Manufacturer Model Name Example (example to `http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
Must Support | true
1048. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).
Control | 1..1
Binding | For example codes, see Software Name Example (example to `http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC
Must Support | true
1050. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
1052. ClinicalDocument.author.assignedAuthor.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1054. ClinicalDocument.dataEnterer
Short | The dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.
Comments | MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
1056. 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
1058. 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
1060. 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()`)
1062. 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
1064. 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
1066. 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
1068. 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`
1070. 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
1072. 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
1074. 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`
1076. 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`
1078. ClinicalDocument.dataEnterer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
1080. ClinicalDocument.dataEnterer.assignedEntity
Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Must Support | true
1082. 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
1084. 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
1086. 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()`)
1088. 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
1090. 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
1092. 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
1094. 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`
1096. 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
1098. 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
1100. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1102. 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
1104. 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`.
1106. ClinicalDocument.dataEnterer.assignedEntity.code
Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32173).
Control | 0..1
Binding | For example codes, see CDARoleCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1108. ClinicalDocument.dataEnterer.assignedEntity.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1110. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1112. 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
1114. 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.
1116. 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
1118. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1120. 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
Must Support | true
1122. 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
1124. 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
1126. 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()`)
1128. 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
1130. 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
1132. 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
1134. 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`
1136. 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
1138. 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
1140. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1142. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1144. 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
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
1146. 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`.
1148. 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`.
1150. 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
1152. 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
1154. 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()`)
1156. 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
1158. 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
1160. 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
1162. 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`
1164. 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
1166. 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
1168. 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`
1170. 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`
1172. 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`.
1174. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1176. 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`.
1178. 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`.
1180. ClinicalDocument.informant
Comments | MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
Slicing | This element introduces a set of slices on `ClinicalDocument.informant`. The slices areUnordered and Open, and can be differentiated using the following discriminators: exists @ relatedEntity exists @ assignedEntity
1182. ClinicalDocument.informant:provider
Slice Name | provider
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
1184. 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
1186. 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
1188. 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()`)
1190. 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
1192. 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
1194. 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
1196. 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`
1198. 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
1200. 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
1202. 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`
1204. 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`
1206. 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
1208. 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
1210. 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
1212. 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()`)
1214. 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
1216. 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
1218. 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
1220. 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`
1222. 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
1224. 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
1226. ClinicalDocument.informant:provider.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1228. 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
1230. 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`.
1232. ClinicalDocument.informant:provider.assignedEntity.code
Control | 0..1
Binding | For example codes, see NUCCProviderCodes (example to `http://terminology.hl7.org/ValueSet/v3-NUCCProviderCodes` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1234. ClinicalDocument.informant:provider.assignedEntity.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1236. ClinicalDocument.informant:provider.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1238. 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
Must Support | true
1240. 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
1242. 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
1244. 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()`)
1246. 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
1248. 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
1250. 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
1252. 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`
1254. 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
1256. 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
1258. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1260. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1262. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
1264. 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`.
1266. 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`.
1268. 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
1270. 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
1272. 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()`)
1274. 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
1276. 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
1278. 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
1280. 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`
1282. 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
1284. 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
1286. 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`
1288. 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`
1290. 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`.
1292. ClinicalDocument.informant:provider.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1294. 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`.
1296. 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`.
1298. ClinicalDocument.informant:provider.relatedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1300. ClinicalDocument.informant:non-provider
Slice Name | non-provider
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
1302. 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
1304. 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
1306. 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()`)
1308. 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
1310. 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
1312. 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
1314. 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`
1316. 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
1318. 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
1320. 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`
1322. 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`
1324. ClinicalDocument.informant:non-provider.assignedEntity
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1326. ClinicalDocument.informant:non-provider.relatedEntity
Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
Must Support | true
1328. ClinicalDocument.custodian
Short | The custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document. There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, 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.
Comments | SHALL contain exactly one [1..1] custodian (CONF:4537-5519).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Custodian
Must Support | true
1330. 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
1332. 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
1334. 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()`)
1336. 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
1338. 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
1340. 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
1342. 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`
1344. 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
1346. 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
1348. 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`
1350. ClinicalDocument.custodian.assignedCustodian
Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
1352. 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
1354. 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
1356. 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()`)
1358. 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
1360. 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
1362. 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
1364. 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`
1366. 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
1368. 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
1370. ClinicalDocument.custodian.assignedCustodian.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1372. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
1374. 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
1376. 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
1378. 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()`)
1380. 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
1382. 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
1384. 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
1386. 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`
1388. 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
1390. 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
1392. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ORG`
1394. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1396. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1398. 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
Must Support | true
1400. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1402. 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
1404. 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.
1406. 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
1408. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1410. 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`.
1412. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1414. ClinicalDocument.informationRecipient
Short | The informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart.
Comments | MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
1416. 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
1418. 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
1420. 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()`)
1422. 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
1424. 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
1426. 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
1428. 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`
1430. 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
1432. 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
1434. 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`
1436. ClinicalDocument.informationRecipient.intendedRecipient
Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
1438. 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
1440. 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
1442. 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()`)
1444. 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
1446. 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
1448. 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
1450. 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`
1452. 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
1454. 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
1456. 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`
1458. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1460. 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`.
1462. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1464. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1466. 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
1468. 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
1470. 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
1472. 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()`)
1474. 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
1476. 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
1478. 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
1480. 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`
1482. 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
1484. 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
1486. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1488. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1490. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
1492. 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`.
1494. 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`.
1496. 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
1498. 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
1500. 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()`)
1502. 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
1504. 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
1506. 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
1508. 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`
1510. 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
1512. 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
1514. 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`
1516. 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`
1518. 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`.
1520. 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
1522. 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
1524. 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
1526. 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()`)
1528. 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
1530. 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
1532. 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
1534. 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`
1536. 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
1538. 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
1540. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ORG`
1542. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1544. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1546. 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
1548. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
1550. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
1552. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control | 0..1
Binding | For example codes, see OrganizationIndustryClassNAICS (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1554. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
1556. ClinicalDocument.legalAuthenticator
Short | The legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical 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. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Comments | SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Must Support | true
1558. 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
1560. 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
1562. 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()`)
1564. 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
1566. 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
1568. 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
1570. 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`
1572. 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
1574. 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
1576. 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`
1578. 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`
1580. ClinicalDocument.legalAuthenticator.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
1582. 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'`)
1584. 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
1586. 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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | `S`
1588. 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
1590. 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
1592. 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
1594. 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
1596. 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`.
1598. 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`.
1600. 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
1602. 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
1604. 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
1606. 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`.
1608. ClinicalDocument.legalAuthenticator.assignedEntity
Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1610. 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
1612. 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
1614. 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()`)
1616. 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
1618. 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
1620. 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
1622. 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`
1624. 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
1626. 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
1628. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1630. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1632. 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`.
1634. ClinicalDocument.legalAuthenticator.assignedEntity.code
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
1636. 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
Must Support | true
Invariants | should-country: SHOULD contain country ()
1638. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1640. 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
1642. 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.
1644. 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
1646. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1648. 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
Must Support | true
1650. 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
1652. 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
1654. 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()`)
1656. 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
1658. 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
1660. 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
1662. 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`
1664. 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
1666. 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
1668. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1670. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1672. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
1674. 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`.
1676. 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`.
1678. 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
1680. 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
1682. 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()`)
1684. 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
1686. 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
1688. 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
1690. 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`
1692. 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
1694. 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
1696. 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`
1698. 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`
1700. 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`.
1702. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1704. 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`.
1706. 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`.
1708. ClinicalDocument.authenticator
Short | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Authenticator
1710. 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
1712. 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
1714. 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()`)
1716. 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
1718. 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
1720. 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
1722. 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`
1724. 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
1726. 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
1728. 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`
1730. ClinicalDocument.authenticator.time
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Must Support | true
1732. 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'`)
1734. 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
1736. 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
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | `S`
1738. 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
1740. 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
1742. 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
1744. 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
1746. 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`.
1748. 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`.
1750. 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
1752. 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
1754. 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
1756. 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`.
1758. ClinicalDocument.authenticator.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1760. 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
1762. 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
1764. 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()`)
1766. 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
1768. 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
1770. 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
1772. 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`
1774. 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
1776. 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
1778. ClinicalDocument.authenticator.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
1780. ClinicalDocument.authenticator.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
1782. 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`.
1784. ClinicalDocument.authenticator.assignedEntity.code
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
1786. 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
1788. 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
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element 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
1790. 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
1792. 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
1794. 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
1796. 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
1798. 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`.
1800. 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`.
1802. 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
1804. 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
1806. 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
1808. ClinicalDocument.authenticator.assignedEntity.addr
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
1810. 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
Must Support | true
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
1812. 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
1814. 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.
1816. 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
1818. 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.
Control | 0..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
1820. 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
Must Support | true
1822. 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
1824. 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
1826. 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()`)
1828. 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
1830. 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
1832. 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
1834. 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`
1836. 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
1838. 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
1840. ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassLivingSubject (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `PSN`
1842. ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `INSTANCE`
1844. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
Must Support | true
Invariants | ihe-pcc-person-name: Either Person.name.given and/or Person.name.family and/or Person.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (`(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`)
1846. 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`.
1848. 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`.
1850. 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
1852. 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
1854. 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()`)
1856. 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
1858. 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
1860. 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
1862. 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`
1864. 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
1866. 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
1868. 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`
1870. 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`
1872. 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`.
1874. ClinicalDocument.authenticator.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
1876. 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`.
1878. 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`.
1880. ClinicalDocument.participant
Short | The participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others 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 | SHOULD contain zero or more [0..*] RelatedPerson participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants | 4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). (`associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()`)
1882. 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
1884. 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
1886. 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()`)
1888. 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
1890. 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
1892. 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
1894. 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`
1896. 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
1898. 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
1900. ClinicalDocument.participant.typeCode
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.
1902. 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`
1904. ClinicalDocument.participant.functionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1906. 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
Must Support | true
1908. ClinicalDocument.participant.associatedEntity
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
1910. 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:4537-9952).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
1912. 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
1914. 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
1916. 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()`)
1918. 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
1920. 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
1922. 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
1924. 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`
1926. 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
1928. 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
1930. 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`
1932. ClinicalDocument.inFulfillmentOf.order
Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Order
1934. 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
1936. 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
1938. 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()`)
1940. 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
1942. 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
1944. 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
1946. 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`
1948. 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
1950. 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
1952. 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`
1954. 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`
1956. ClinicalDocument.inFulfillmentOf.order.id
Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
1958. ClinicalDocument.inFulfillmentOf.order.code
Control | 0..1
Binding | For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1960. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
1962. ClinicalDocument.documentationOf
Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
1964. 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
1966. 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
1968. 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()`)
1970. 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
1972. 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
1974. 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
1976. 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`
1978. 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
1980. 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
1982. 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`
1984. 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:4537-14836).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
Invariants | should-us-performer: SHOULD contain performer (`performer.exists()`)
1986. 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
1988. 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
1990. 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()`)
1992. 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
1994. 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
1996. 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
1998. 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`
2000. 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
2002. 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
2004. 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`
2006. 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`
2008. ClinicalDocument.documentationOf.serviceEvent.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2010. ClinicalDocument.documentationOf.serviceEvent.code
Definition | Drawn from concept domain ActCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2012. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Must Support | true
2014. 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
2016. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
Control | 0..1
Type | 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.
2018. 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`
2020. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition | This is the low limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Must Support | true
Label | Low Boundary
2022. 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
2024. 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
2026. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition | This is the high limit of the interval.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
2028. ClinicalDocument.documentationOf.serviceEvent.performer
Short | The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments | This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1
Must Support | true
2030. 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
2032. 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
2034. 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()`)
2036. 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
2038. 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
2040. 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
2042. 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`
2044. 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
2046. 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
2048. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Control | 1..1
Binding | The codes SHALL be taken from x_ServiceEventPerformer (required to `http://terminology.hl7.org/ValueSet/v3-xServiceEventPerformer` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
2050. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
Must Support | true
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
2052. ClinicalDocument.documentationOf.serviceEvent.performer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Must Support | true
2054. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments | The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-14841).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-us-code: SHOULD contain code (`code.exists()`)
2056. 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
2058. 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
2060. 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()`)
2062. 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
2064. 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
2066. 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
2068. 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`
2070. 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
2072. 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
2074. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
2076. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
2078. 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`.
2080. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
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
2082. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
2084. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
2086. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
2088. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
2090. 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`.
2092. 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`.
2094. ClinicalDocument.relatedDocument
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
2096. 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
2098. 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
2100. 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
2102. 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()`)
2104. 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
2106. 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
2108. 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
2110. 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`
2112. 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
2114. 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
2116. ClinicalDocument.authorization.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipAuthorizedBy (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may 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`
2118. 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
Must Support | true
2120. 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
2122. 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
2124. 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()`)
2126. 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
2128. 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
2130. 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
2132. 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`
2134. 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
2136. 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
2138. 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`
2140. 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`
2142. 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
2144. 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 v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2146. 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 (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
Must Support | true
2148. 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
2150. 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`
2152. 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
2154. 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
2156. 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
2158. 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
2160. 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`.
2162. 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`.
2164. 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
2166. 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
2168. 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
2170. ClinicalDocument.componentOf
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
Must Support | true
2172. 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
2174. 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
2176. 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()`)
2178. 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
2180. 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
2182. 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
2184. 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`
2186. 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
2188. 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
2190. ClinicalDocument.componentOf.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipHasComponent (required to `http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `COMP`
2192. 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()`)
2194. 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
2196. 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
2198. 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()`)
2200. 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
2202. 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
2204. 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
2206. 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`
2208. 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
2210. 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
2212. 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`
2214. 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`
2216. ClinicalDocument.componentOf.encompassingEncounter.id
Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
2218. ClinicalDocument.componentOf.encompassingEncounter.code
Control | 0..1
Binding | For example codes, see ActEncounterCode (example to `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2220. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Must Support | true
2222. 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`.
2224. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control | 0..1
Binding | For example codes, see USEncounterDischargeDisposition (example to `http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
2226. 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.
Short | The responsibleParty element records only the party responsible for the encounter, not necessarily the entire episode of care.
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
Must Support | true
Invariants | 1198-8348: The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). (`assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()`)
2228. 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
2230. 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
2232. 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()`)
2234. 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
2236. 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
2238. 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
2240. 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`
2242. 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
2244. 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
2246. 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`
2248. 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
Must Support | true
Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (`assignedPerson.exists() or representedOrganization.exists()`)
2250. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Short | The encounterParticipant elements represent only those participants in the encounter, not necessarily the entire episode of care.
Comments | This encompassingEncounter MAY contain zero or more [0..*] encounterParticipant (CONF:1198-8342).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
Invariants | 1198-8348: The responsibleParty element, if present, **SHALL** contain an assignedEntity element, which **SHALL** contain an assignedPerson element, a representedOrganization element, or both (CONF:1198-8348). (`assignedEntity.assignedPerson.exists() or assignedEntity.representedOrganization.exists()`)
2252. 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.
Comments | This encompassingEncounter MAY contain zero or one [0..1] location (CONF:1198-8344).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Must Support | true
2254. 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
2256. 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
2258. 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()`)
2260. 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
2262. 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
2264. 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
2266. 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`
2268. 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
2270. 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
2272. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ParticipationTargetLocation (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `LOC`
2274. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
2276. ClinicalDocument.component
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Component