Consolidated CDA (C-CDA)
5.0.0-ballot - STU5 - Ballot 1
Consolidated CDA (C-CDA)
5.0.0-ballot - STU5 - Ballot 1
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Draft as of 2025-12-04 |
Definitions for the USRealmHeader logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ClinicalDocument | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (setId.exists() implies versionNumber.exists())4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ( versionNumber.exists() implies setId.exists())should-legalAuthenticator: SHOULD contain legalAuthenticator ( legalAuthenticator.exists())should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant ( participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()) |
| 2. ClinicalDocument.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 4. ClinicalDocument.classCode | |
| Control | 0..1 |
| Binding | For example codes, see CDAActClass (example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | DOCCLIN |
| 6. ClinicalDocument.moodCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDAActMood (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | EVN |
| 8. ClinicalDocument.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Comments | SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 10. ClinicalDocument.realmCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 12. ClinicalDocument.realmCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | US |
| 14. ClinicalDocument.realmCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 16. ClinicalDocument.realmCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 18. ClinicalDocument.realmCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 20. ClinicalDocument.realmCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 22. ClinicalDocument.realmCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 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 namevalueSetVersion. |
| 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:typeattribute. |
| Label | Translation |
| 32. ClinicalDocument.typeId | |
| Definition | ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description). |
| Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 34. ClinicalDocument.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 36. ClinicalDocument.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 38. ClinicalDocument.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 40. ClinicalDocument.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 42. ClinicalDocument.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251). |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| Fixed Value | POCD_HD000040 |
| 44. ClinicalDocument.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ClinicalDocument.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. ClinicalDocument.templateId:us-realm | |
| Slice Name | us-realm |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 48. ClinicalDocument.templateId:us-realm.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 50. ClinicalDocument.templateId:us-realm.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 52. ClinicalDocument.templateId:us-realm.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 54. ClinicalDocument.templateId:us-realm.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.1.1 |
| 56. ClinicalDocument.templateId:us-realm.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| Pattern Value | 2024-05-01 |
| 58. ClinicalDocument.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). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 60. ClinicalDocument.sdtcCategory | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namecategory. |
| 62. 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 |
| 64. ClinicalDocument.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 66. ClinicalDocument.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 68. ClinicalDocument.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| Pattern Value | 2.16.840.1.113883.6.1 |
| 70. ClinicalDocument.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 72. 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 |
| 74. ClinicalDocument.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 76. 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 namevalueSet. |
| 78. 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 namevalueSetVersion. |
| 80. 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 |
| 82. 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 |
| 84. 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:typeattribute. |
| Label | Translation |
| 86. 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 |
| 88. 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 namestatusCode. |
| 90. ClinicalDocument.effectiveTime | |
| Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 92. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 94. 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 |
| 96. ClinicalDocument.confidentialityCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind  (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 98. 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 |
| 100. 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 |
| 102. 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 |
| 104. 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 |
| 106. 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 namevalueSet. |
| 108. 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 namevalueSetVersion. |
| 110. 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 |
| 112. 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 |
| 114. 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:typeattribute. |
| Label | Translation |
| 116. 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 |
| 118. ClinicalDocument.setId | |
| Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261). |
| Control | 0..1 This element is affected by the following invariants: 4537-6380, 4537-6387 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 120. ClinicalDocument.versionNumber | |
| Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264). |
| Control | 0..1 This element is affected by the following invariants: 4537-6380, 4537-6387 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 122. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 124. 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 |
| 126. 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 |
| 128. 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 |
| 130. 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()) |
| 132. 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 |
| 134. 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 |
| 136. 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 |
| 138. 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 |
| 140. 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 |
| 142. 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 |
| 144. 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 |
| 146. 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 |
| 148. 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 |
| 150. 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 |
| 152. 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 |
| 154. 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()) |
| 156. 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 |
| 158. 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 |
| 160. 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 |
| 162. 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 |
| 164. 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 |
| 166. 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 |
| 168. 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 |
| 170. 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 |
| 172. 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 nameidentifiedBy. |
| 174. ClinicalDocument.recordTarget.patientRole.addr | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Address |
| Comments | This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 176. ClinicalDocument.recordTarget.patientRole.telecom | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Phone Number / Email |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 178. 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 |
| 180. 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. |
| 182. 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:typeattribute. |
| Label | Useable Period |
| 184. ClinicalDocument.recordTarget.patientRole.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 186. 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 |
| Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists())4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true ( sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true'))should-maritalStatusCode: SHOULD contain maritalStatusCode ( maritalStatusCode.exists())should-us-languageCommunication: SHOULD contain languageCommunication ( languageCommunication.exists()) |
| 188. 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 |
| 190. 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 |
| 192. 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()) |
| 194. 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 |
| 196. 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 |
| 198. 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 |
| 200. 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 |
| 202. 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 |
| 204. 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 |
| 206. 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 |
| 208. 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 |
| 210. 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/IIid |
| Is Modifier | false |
| 212. ClinicalDocument.recordTarget.patientRole.patient.name | |
| Definition | A name associated with the individual. |
| Short | A name associated with the patient |
| Comments | This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284). A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Patient Name (PTN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 214. 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 namedesc. |
| 216. 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 |
| 218. ClinicalDocument.recordTarget.patientRole.patient.birthTime | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured) |
| Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| Invariants | ts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)ts-should-day: **SHOULD** be precise to at least the day ( nullFlavor.exists() or value.toString().length() >= 10) |
| 220. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd | |
| Short | sdtc:deceasedInd |
| Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd. |
| 222. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Date of Death |
| Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime. |
| 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) |
| 224. 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 namemultipleBirthInd. |
| 226. 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 namemultipleBirthOrderNumber. |
| 228. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode | |
| Short |  Added:SHOULD contain maritalStatusCode |
| Comments | This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303). |
| Control | 0..1 This element is affected by the following invariants: should-maritalStatusCode |
| Binding | The codes SHALL be taken from Marital Status (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 230. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode | |
| Comments | This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Religious Affiliation (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 232. ClinicalDocument.recordTarget.patientRole.patient.raceCode | |
| Short |  Changed:𝗨𝗦𝗖𝗗𝗜: Race - raceCode SHALL contain only the OMB race category; detailed race values go in translation. Additional race categories are conveyed using sdtc:raceCode, following the same pattern (OMB category in root; details in translation). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Race Categories (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.2.575) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 234. ClinicalDocument.recordTarget.patientRole.patient.raceCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 236. ClinicalDocument.recordTarget.patientRole.patient.raceCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 238. ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 240. ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 242. ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 244. ClinicalDocument.recordTarget.patientRole.patient.raceCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 246. ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 248. ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 250. ClinicalDocument.recordTarget.patientRole.patient.raceCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 252. ClinicalDocument.recordTarget.patientRole.patient.raceCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 254. ClinicalDocument.recordTarget.patientRole.patient.raceCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Binding | The codes SHOULD be taken from Race Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. ((code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()) |
| 256. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements. |
| Control | 0..* |
| Binding | The codes SHALL be taken from Detailed race including absence reasons. (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.25) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode. |
| Invariants | sdtc-race-not-detail: When using translation to convey race details, the base code SHALL be a race category. (translation.exists(codeSystem = '2.16.840.1.113883.6.238') implies (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1'))) |
| 258. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 260. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 262. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 264. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 266. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 268. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 270. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 272. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 274. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 276. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 278. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Binding | The codes SHOULD be taken from Race Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. ((code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()) |
| 280. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Ethnicity Categories (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.3) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 282. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity |
| Control | 0..* |
| Binding | The codes SHALL be taken from Detailed Ethnicity Including Absence Reasons (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.1) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode. |
| 284. ClinicalDocument.recordTarget.patientRole.patient.guardian | |
| Comments | This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian |
| 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()) |
| 286. 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 |
| 288. 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 |
| 290. 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()) |
| 292. 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 |
| 294. 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 |
| 296. 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 |
| 298. 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 |
| 300. 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 |
| 302. 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 |
| 304. 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 |
| 306. ClinicalDocument.recordTarget.patientRole.patient.guardian.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 308. 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 nameidentifiedBy. |
| 310. ClinicalDocument.recordTarget.patientRole.patient.guardian.code | |
| Comments | The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-5326). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 312. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr | |
| Comments | The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 314. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom | |
| Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 316. 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 |
| 318. 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. |
| 320. 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:typeattribute. |
| Label | Useable Period |
| 322. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 324. 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 |
| 326. 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 |
| 328. 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 |
| 330. 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()) |
| 332. 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 |
| 334. 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 |
| 336. 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 |
| 338. 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 |
| 340. 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 |
| 342. 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 |
| 344. 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 |
| 346. 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 |
| 348. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386). Person may have multiple names with different uses or applicable periods. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 350. 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 namedesc. |
| 352. 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 nameasPatientRelationship. |
| 354. 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 |
| 356. 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 |
| 358. 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()) |
| 360. 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 |
| 362. 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 |
| 364. 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 |
| 366. 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 |
| 368. 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 |
| 370. 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 |
| 372. 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 |
| 374. 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 |
| 376. 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. |
| 378. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 380. 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 |
| 382. 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 |
| 384. 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 |
| 386. 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()) |
| 388. 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 |
| 390. 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 |
| 392. 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 |
| 394. 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 |
| 396. 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 |
| 398. 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 |
| 400. 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 |
| 402. 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 |
| 404. 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 |
| 406. 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 |
| 408. 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()) |
| 410. 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 |
| 412. 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 |
| 414. 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 |
| 416. 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 |
| 418. 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 |
| 420. 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 |
| 422. 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 |
| 424. 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 |
| 426. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
| 428. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr | |
| Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| Invariants | 4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://terminology.hl7.org/ValueSet/USPS-State')))4537-5403: If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists()) |
| 430. 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 |
| 432. 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 |
| 434. 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 |
| 436. 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) |
| 438. 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) |
| 440. 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 |
| 442. 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 |
| 444. 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 |
| 446. 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 |
| 448. 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. |
| 450. 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 |
| 452. 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) |
| 454. 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 |
| 456. 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 |
| 458. 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 |
| 460. 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 |
| 462. 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. |
| 464. 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 |
| 466. 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) |
| 468. 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 |
| 470. 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 |
| 472. 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 |
| 474. 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 |
| 476. 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. |
| 478. 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 |
| 480. 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) |
| 482. 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 |
| 484. 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 |
| 486. 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 |
| 488. 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 |
| 490. 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. |
| 492. 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 |
| 494. 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) |
| 496. 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 |
| 498. 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 |
| 500. 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 |
| 502. 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 |
| 504. 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. |
| 506. 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 |
| 508. 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) |
| 510. 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 |
| 512. 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 |
| 514. 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 |
| 516. 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 |
| 518. 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. |
| 520. 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 |
| 522. 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) |
| 524. 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 |
| 526. 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 |
| 528. 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 |
| 530. 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 |
| 532. 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. |
| 534. 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 |
| 536. 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) |
| 538. 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 |
| 540. 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 |
| 542. 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 |
| 544. 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 |
| 546. 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. |
| 548. 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 |
| 550. 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) |
| 552. 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 |
| 554. 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 |
| 556. 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 |
| 558. 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 |
| 560. 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. |
| 562. 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 |
| 564. 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) |
| 566. 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 |
| 568. 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 |
| 570. 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 |
| 572. 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 |
| 574. 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. |
| 576. 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 |
| 578. 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) |
| 580. 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 |
| 582. 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 |
| 584. 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 |
| 586. 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 |
| 588. 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. |
| 590. 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 |
| 592. 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) |
| 594. 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 |
| 596. 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 |
| 598. 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 |
| 600. 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 |
| 602. 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. |
| 604. 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 |
| 606. 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) |
| 608. 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 |
| 610. 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 |
| 612. 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 |
| 614. 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 |
| 616. 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. |
| 618. 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 |
| 620. 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) |
| 622. 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 |
| 624. 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 |
| 626. 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 |
| 628. 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 |
| 630. 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. |
| 632. 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 |
| 634. 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) |
| 636. 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 |
| 638. 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 |
| 640. 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 |
| 642. 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 |
| 644. 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. |
| 646. 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 |
| 648. 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) |
| 650. 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 |
| 652. 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 |
| 654. 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 |
| 656. 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 |
| 658. 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. |
| 660. 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 |
| 662. 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) |
| 664. 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 |
| 666. 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 |
| 668. 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 |
| 670. 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 |
| 672. 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. |
| 674. 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 |
| 676. 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) |
| 678. 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 |
| 680. 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 |
| 682. 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 |
| 684. 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 |
| 686. 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. |
| 688. 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 |
| 690. 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) |
| 692. 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 |
| 694. 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 |
| 696. 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 |
| 698. 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 |
| 700. 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. |
| 702. 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 |
| 704. 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) |
| 706. 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 |
| 708. 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 |
| 710. 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 |
| 712. 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 |
| 714. 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. |
| 716. 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 |
| 718. 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) |
| 720. 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 |
| 722. 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 |
| 724. 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 |
| 726. 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 |
| 728. 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. |
| 730. 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 |
| 732. 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) |
| 734. 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 |
| 736. 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 |
| 738. 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 |
| 740. 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 |
| 742. 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. |
| 744. 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 |
| 746. 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) |
| 748. 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 |
| 750. 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 |
| 752. 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 |
| 754. 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 |
| 756. 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. |
| 758. 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 |
| 760. 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) |
| 762. 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 |
| 764. 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 |
| 766. 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 |
| 768. 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 |
| 770. 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. |
| 772. 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 |
| 774. 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) |
| 776. 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 |
| 778. 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 |
| 780. 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 |
| 782. 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 |
| 784. 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. |
| 786. 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 |
| 788. 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) |
| 790. 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 |
| 792. 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 |
| 794. 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 |
| 796. 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 |
| 798. 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. |
| 800. 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 |
| 802. 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) |
| 804. 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 |
| 806. 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 |
| 808. 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 |
| 810. 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 |
| 812. 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. |
| 814. 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 |
| 816. 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. |
| 818. 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:typeattribute. |
| Label | Useable Period |
| 820. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Preferred Language |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication |
| Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (proficiencyLevelCode.exists())should-preferenceInd: SHOULD contain preferenceInd ( preferenceInd.exists()) |
| 822. 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 |
| 824. 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 |
| 826. 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()) |
| 828. 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 |
| 830. 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 |
| 832. 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 |
| 834. 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 |
| 836. 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 |
| 838. 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 |
| 840. 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 |
| 842. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode | |
| Comments | The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:4537-5409). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from LanguageAbilityMode (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 844. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode | |
| Short | Added:SHOULD contain proficiencyLevelCode |
| Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:4537-9965). |
| Control | 0..1 This element is affected by the following invariants: should-proficiencyLevelCode |
| Binding | The codes SHALL be taken from LanguageAbilityProficiency (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 846. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd | |
| Short | Added:SHOULD contain preferenceInd |
| Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414). |
| Control | 0..1 This element is affected by the following invariants: should-preferenceInd |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 848. 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 |
| 850. 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 |
| 852. 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 |
| 854. 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()) |
| 856. 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 |
| 858. 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 |
| 860. 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 |
| 862. 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 |
| 864. 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 |
| 866. 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 |
| 868. 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 |
| 870. 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 |
| 872. 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/IIid |
| Is Modifier | false |
| 874. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 876. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 878. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 880. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16820). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 882. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 884. 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/ONstring |
| 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())) |
| 886. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 888. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 890. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value | |
| Control | 0..1 |
| Type | url(url: Universal Resource Locator) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 892. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Useable Period |
| 894. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7994). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 896. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5422). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 898. 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 |
| 900. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf |
| 902. 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 |
| 904. 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 |
| 906. 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 |
| 908. 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()) |
| 910. 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 |
| 912. 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 |
| 914. 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 |
| 916. 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 |
| 918. 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 |
| 920. 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 |
| 922. 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 |
| 924. 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 |
| 926. ClinicalDocument.author.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 928. ClinicalDocument.author.time | |
| Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 930. ClinicalDocument.author.assignedAuthor | |
| Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor |
| Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ((assignedPerson | assignedAuthoringDevice).count() = 1)should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) ( id.where(root = '2.16.840.1.113883.4.6'))should-us-code: SHOULD contain code ( code.exists()) |
| 932. 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 |
| 934. 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 |
| 936. 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()) |
| 938. 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 |
| 940. 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 |
| 942. 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 |
| 944. 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 |
| 946. 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 |
| 948. 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 |
| 950. 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 |
| 952. ClinicalDocument.author.assignedAuthor.id | |
| Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 954. ClinicalDocument.author.assignedAuthor.id:npi | |
| Slice Name | npi |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | should-extension: SHOULD contain extension (extension.exists()) |
| 956. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 958. ClinicalDocument.author.assignedAuthor.id:npi.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 960. ClinicalDocument.author.assignedAuthor.id:npi.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 962. ClinicalDocument.author.assignedAuthor.id:npi.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 964. ClinicalDocument.author.assignedAuthor.id:npi.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4537-32885). |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 966. 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 nameidentifiedBy. |
| 968. 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 |
| 970. 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 |
| 972. ClinicalDocument.author.assignedAuthor.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 974. 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 |
| 976. 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 |
| 978. 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 |
| 980. 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 |
| 982. 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 namevalueSet. |
| 984. 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 namevalueSetVersion. |
| 986. 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 |
| 988. 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 |
| 990. 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:typeattribute. |
| Label | Translation |
| 992. ClinicalDocument.author.assignedAuthor.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 994. ClinicalDocument.author.assignedAuthor.addr | |
| Comments | This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 996. ClinicalDocument.author.assignedAuthor.telecom | |
| Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 998. 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 |
| 1000. 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. |
| 1002. 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:typeattribute. |
| Label | Useable Period |
| 1004. ClinicalDocument.author.assignedAuthor.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1006. ClinicalDocument.author.assignedAuthor.assignedPerson | |
| Comments | MAY contain assignedPerson |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 1008. 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 |
| 1010. 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 |
| 1012. 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()) |
| 1014. 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 |
| 1016. 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 |
| 1018. 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 |
| 1020. 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 |
| 1022. 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 |
| 1024. 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 |
| 1026. 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 |
| 1028. 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 |
| 1030. ClinicalDocument.author.assignedAuthor.assignedPerson.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-16789). Person may have multiple names with different uses or applicable periods. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1032. 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 namedesc. |
| 1034. 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 nameasPatientRelationship. |
| 1036. 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 |
| 1038. 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 |
| 1040. 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()) |
| 1042. 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 |
| 1044. 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 |
| 1046. 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 |
| 1048. 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 |
| 1050. 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 |
| 1052. 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 |
| 1054. 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 |
| 1056. 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 |
| 1058. 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. |
| 1060. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice | |
| Comments | MAY contain assignedAuthoringDevice |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice |
| 1062. 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 |
| 1064. 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 |
| 1066. 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()) |
| 1068. 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 |
| 1070. 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 |
| 1072. 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 |
| 1074. 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 |
| 1076. 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 |
| 1078. 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 |
| 1080. 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 |
| 1082. 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 |
| 1084. 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 |
| 1086. 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 |
| 1088. 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 |
| 1090. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity |
| 1092. ClinicalDocument.author.assignedAuthor.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1094. 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 |
| 1096. 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 |
| 1098. 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 |
| 1100. 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()) |
| 1102. 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 |
| 1104. 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 |
| 1106. 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 |
| 1108. 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 |
| 1110. 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 |
| 1112. 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 |
| 1114. 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 |
| 1116. 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 |
| 1118. ClinicalDocument.dataEnterer.time | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 1120. 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 |
| 1122. 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 |
| 1124. 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 |
| 1126. 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()) |
| 1128. 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 |
| 1130. 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 |
| 1132. 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 |
| 1134. 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 |
| 1136. 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 |
| 1138. 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 |
| 1140. 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 |
| 1142. 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 |
| 1144. ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1146. ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1148. ClinicalDocument.dataEnterer.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1150. ClinicalDocument.dataEnterer.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16821). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 1152. ClinicalDocument.dataEnterer.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1154. 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 nameidentifiedBy. |
| 1156. ClinicalDocument.dataEnterer.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32173). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1158. ClinicalDocument.dataEnterer.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1160. ClinicalDocument.dataEnterer.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5460). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1162. ClinicalDocument.dataEnterer.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1164. 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 |
| 1166. 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. |
| 1168. 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:typeattribute. |
| Label | Useable Period |
| 1170. ClinicalDocument.dataEnterer.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7996). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1172. 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 |
| 1174. 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 |
| 1176. 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 |
| 1178. 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()) |
| 1180. 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 |
| 1182. 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 |
| 1184. 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 |
| 1186. 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 |
| 1188. 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 |
| 1190. 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 |
| 1192. 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 |
| 1194. 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 |
| 1196. 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/PNHumanName(US Realm Person Name (PN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1198. 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 namedesc. |
| 1200. 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 nameasPatientRelationship. |
| 1202. 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 |
| 1204. 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 |
| 1206. 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()) |
| 1208. 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 |
| 1210. 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 |
| 1212. 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 |
| 1214. 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 |
| 1216. 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 |
| 1218. 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 |
| 1220. 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 |
| 1222. 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 |
| 1224. 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. |
| 1226. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1228. 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 namepatient. |
| 1230. 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. |
| 1232. 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: |
| 1234. 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 |
| 1236. 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 |
| 1238. 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 |
| 1240. 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()) |
| 1242. 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 |
| 1244. 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 |
| 1246. 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 |
| 1248. 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 |
| 1250. 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 |
| 1252. 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 |
| 1254. 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 |
| 1256. 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 |
| 1258. 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 |
| 1260. 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 |
| 1262. 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 |
| 1264. 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()) |
| 1266. 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 |
| 1268. 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 |
| 1270. 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 |
| 1272. 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 |
| 1274. 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 |
| 1276. 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 |
| 1278. 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 |
| 1280. 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 |
| 1282. 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 nameidentifiedBy. |
| 1284. ClinicalDocument.informant:provider.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32174). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1286. ClinicalDocument.informant:provider.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1288. ClinicalDocument.informant:provider.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1290. ClinicalDocument.informant:provider.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 1292. 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 |
| 1294. 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 |
| 1296. 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 |
| 1298. 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()) |
| 1300. 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 |
| 1302. 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 |
| 1304. 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 |
| 1306. 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 |
| 1308. 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 |
| 1310. 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 |
| 1312. 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 |
| 1314. 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 |
| 1316. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222). Person may have multiple names with different uses or applicable periods. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1318. 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 namedesc. |
| 1320. 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 nameasPatientRelationship. |
| 1322. 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 |
| 1324. 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 |
| 1326. 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()) |
| 1328. 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 |
| 1330. 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 |
| 1332. 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 |
| 1334. 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 |
| 1336. 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 |
| 1338. 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 |
| 1340. 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 |
| 1342. 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 |
| 1344. 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. |
| 1346. ClinicalDocument.informant:provider.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1348. 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 namepatient. |
| 1350. 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. |
| 1352. ClinicalDocument.informant:provider.relatedEntity | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity |
| 1354. 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 |
| 1356. 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 |
| 1358. 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 |
| 1360. 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()) |
| 1362. 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 |
| 1364. 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 |
| 1366. 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 |
| 1368. 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 |
| 1370. 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 |
| 1372. 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 |
| 1374. 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 |
| 1376. 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 |
| 1378. ClinicalDocument.informant:non-provider.assignedEntity | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
| 1380. 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 |
| 1382. 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 |
| 1384. 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 |
| 1386. 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 |
| 1388. 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()) |
| 1390. 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 |
| 1392. 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 |
| 1394. 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 |
| 1396. 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 |
| 1398. 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 |
| 1400. 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 |
| 1402. 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 |
| 1404. 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 |
| 1406. 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 |
| 1408. 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 |
| 1410. 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()) |
| 1412. 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 |
| 1414. 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 |
| 1416. 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 |
| 1418. 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 |
| 1420. 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 |
| 1422. 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 |
| 1424. 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 |
| 1426. 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 |
| 1428. 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 |
| 1430. 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 |
| 1432. 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()) |
| 1434. 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 |
| 1436. 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 |
| 1438. 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 |
| 1440. 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 |
| 1442. 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 |
| 1444. 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 |
| 1446. 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 |
| 1448. 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 |
| 1450. 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 |
| 1452. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1454. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1456. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1458. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16822). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 1460. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1462. 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 |
| 1464. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom | |
| Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1466. 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 |
| 1468. 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. |
| 1470. 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:typeattribute. |
| Label | Useable Period |
| 1472. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1474. 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 nametelecom. |
| 1476. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr | |
| Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1478. 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 |
| 1480. 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 |
| 1482. 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 |
| 1484. 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()) |
| 1486. 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 |
| 1488. 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 |
| 1490. 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 |
| 1492. 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 |
| 1494. 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 |
| 1496. 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 |
| 1498. 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 |
| 1500. 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 |
| 1502. 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 |
| 1504. 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 |
| 1506. 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()) |
| 1508. 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 |
| 1510. 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 |
| 1512. 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 |
| 1514. 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 |
| 1516. 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 |
| 1518. 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 |
| 1520. 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 |
| 1522. 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 |
| 1524. 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 nameidentifiedBy. |
| 1526. ClinicalDocument.informationRecipient.intendedRecipient.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 1528. ClinicalDocument.informationRecipient.intendedRecipient.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 1530. 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 |
| 1532. 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 |
| 1534. 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 |
| 1536. 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()) |
| 1538. 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 |
| 1540. 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 |
| 1542. 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 |
| 1544. 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 |
| 1546. 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 |
| 1548. 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 |
| 1550. 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 |
| 1552. 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 |
| 1554. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5568). Person may have multiple names with different uses or applicable periods. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1556. 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 namedesc. |
| 1558. 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 nameasPatientRelationship. |
| 1560. 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 |
| 1562. 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 |
| 1564. 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()) |
| 1566. 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 |
| 1568. 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 |
| 1570. 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 |
| 1572. 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 |
| 1574. 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 |
| 1576. 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 |
| 1578. 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 |
| 1580. 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 |
| 1582. 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. |
| 1584. 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 |
| 1586. 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 |
| 1588. 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 |
| 1590. 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()) |
| 1592. 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 |
| 1594. 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 |
| 1596. 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 |
| 1598. 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 |
| 1600. 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 |
| 1602. 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 |
| 1604. 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 |
| 1606. 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 |
| 1608. 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/IIid |
| Is Modifier | false |
| 1610. 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/ONstring |
| 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())) |
| 1612. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 1614. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 1616. 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 |
| 1618. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf |
| 1620. 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 This element is affected by the following invariants: should-legalAuthenticator |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator |
| 1622. 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 |
| 1624. 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 |
| 1626. 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()) |
| 1628. 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 |
| 1630. 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 |
| 1632. 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 |
| 1634. 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 |
| 1636. 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 |
| 1638. 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 |
| 1640. 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 |
| 1642. 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 |
| 1644. ClinicalDocument.legalAuthenticator.time | |
| Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 1646. 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') |
| 1648. 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 |
| 1650. ClinicalDocument.legalAuthenticator.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5584). |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | S |
| 1652. 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 |
| 1654. 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 |
| 1656. 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 |
| 1658. 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 |
| 1660. 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 namevalueSet. |
| 1662. 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 namevalueSetVersion. |
| 1664. 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 |
| 1666. 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 |
| 1668. 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:typeattribute. |
| Label | Translation |
| 1670. 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 namesignatureText. |
| 1672. 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 |
| 1674. 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 |
| 1676. 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 |
| 1678. 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()) |
| 1680. 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 |
| 1682. 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 |
| 1684. 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 |
| 1686. 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 |
| 1688. 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 |
| 1690. 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 |
| 1692. 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 |
| 1694. 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 |
| 1696. ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1698. ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1700. ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1702. ClinicalDocument.legalAuthenticator.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Short | MAY contain '2.16.840.1.113883.4.6' (NPI) |
| Comments | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| 1704. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1706. 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 nameidentifiedBy. |
| 1708. ClinicalDocument.legalAuthenticator.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-17000). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1710. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1712. ClinicalDocument.legalAuthenticator.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5589). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1714. ClinicalDocument.legalAuthenticator.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1716. 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 |
| 1718. 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. |
| 1720. 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:typeattribute. |
| Label | Useable Period |
| 1722. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7999). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1724. 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 |
| 1726. 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 |
| 1728. 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 |
| 1730. 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()) |
| 1732. 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 |
| 1734. 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 |
| 1736. 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 |
| 1738. 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 |
| 1740. 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 |
| 1742. 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 |
| 1744. 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 |
| 1746. 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 |
| 1748. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5598). Person may have multiple names with different uses or applicable periods. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1750. 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 namedesc. |
| 1752. 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 nameasPatientRelationship. |
| 1754. 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 |
| 1756. 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 |
| 1758. 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()) |
| 1760. 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 |
| 1762. 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 |
| 1764. 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 |
| 1766. 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 |
| 1768. 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 |
| 1770. 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 |
| 1772. 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 |
| 1774. 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 |
| 1776. 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. |
| 1778. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1780. 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 namepatient. |
| 1782. 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. |
| 1784. 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 |
| 1786. 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 |
| 1788. 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 |
| 1790. 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()) |
| 1792. 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 |
| 1794. 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 |
| 1796. 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 |
| 1798. 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 |
| 1800. 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 |
| 1802. 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 |
| 1804. 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 |
| 1806. ClinicalDocument.authenticator.time | |
| Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 1808. 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') |
| 1810. 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 |
| 1812. ClinicalDocument.authenticator.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5611). |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | S |
| 1814. 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 |
| 1816. 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 |
| 1818. 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 |
| 1820. 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 |
| 1822. 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 namevalueSet. |
| 1824. 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 namevalueSetVersion. |
| 1826. 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 |
| 1828. 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 |
| 1830. 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:typeattribute. |
| Label | Translation |
| 1832. 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 namesignatureText. |
| 1834. 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 |
| 1836. 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 |
| 1838. 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 |
| 1840. 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()) |
| 1842. 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 |
| 1844. 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 |
| 1846. 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 |
| 1848. 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 |
| 1850. 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 |
| 1852. 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 |
| 1854. 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 |
| 1856. 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 |
| 1858. ClinicalDocument.authenticator.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1860. ClinicalDocument.authenticator.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1862. ClinicalDocument.authenticator.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1864. ClinicalDocument.authenticator.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 1866. ClinicalDocument.authenticator.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1868. 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 nameidentifiedBy. |
| 1870. ClinicalDocument.authenticator.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825). |
| 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 |
| 1872. 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 |
| 1874. ClinicalDocument.authenticator.assignedEntity.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-16826). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 1876. 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 |
| 1878. 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 |
| 1880. 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 |
| 1882. 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 |
| 1884. 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 namevalueSet. |
| 1886. 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 namevalueSetVersion. |
| 1888. 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 |
| 1890. 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 |
| 1892. 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:typeattribute. |
| Label | Translation |
| 1894. ClinicalDocument.authenticator.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1896. ClinicalDocument.authenticator.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5616). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1898. ClinicalDocument.authenticator.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1900. 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 |
| 1902. 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. |
| 1904. 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:typeattribute. |
| Label | Useable Period |
| 1906. ClinicalDocument.authenticator.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-8000). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1908. 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 |
| 1910. 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 |
| 1912. 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 |
| 1914. 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()) |
| 1916. 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 |
| 1918. 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 |
| 1920. 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 |
| 1922. 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 |
| 1924. 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 |
| 1926. 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 |
| 1928. 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 |
| 1930. 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 |
| 1932. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625). Person may have multiple names with different uses or applicable periods. |
| Control | 10..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED)) |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 1934. 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 namedesc. |
| 1936. 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 nameasPatientRelationship. |
| 1938. 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 |
| 1940. 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 |
| 1942. 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()) |
| 1944. 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 |
| 1946. 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 |
| 1948. 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 |
| 1950. 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 |
| 1952. 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 |
| 1954. 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 |
| 1956. 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 |
| 1958. 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 |
| 1960. 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. |
| 1962. ClinicalDocument.authenticator.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1964. 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 namepatient. |
| 1966. 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. |
| 1968. 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())4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). ( typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33')) |
| 1970. 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 |
| 1972. 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 |
| 1974. 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()) |
| 1976. 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 |
| 1978. 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 |
| 1980. 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 |
| 1982. 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 |
| 1984. 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 |
| 1986. 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 |
| 1988. 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. |
| 1990. 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 |
| 1992. ClinicalDocument.participant.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1994. ClinicalDocument.participant.time | |
| Comments | MAY contain zero or one [0..1] time (CONF:4537-10004). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 1996. ClinicalDocument.participant.associatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity |
| 1998. 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 |
| 2000. 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 |
| 2002. 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 |
| 2004. 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()) |
| 2006. 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 |
| 2008. 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 |
| 2010. 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 |
| 2012. 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 |
| 2014. 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 |
| 2016. 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 |
| 2018. 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 |
| 2020. 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 |
| 2022. 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 |
| 2024. 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 |
| 2026. 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()) |
| 2028. 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 |
| 2030. 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 |
| 2032. 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 |
| 2034. 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 |
| 2036. 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 |
| 2038. 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 |
| 2040. 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 |
| 2042. 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 |
| 2044. 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 |
| 2046. 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 |
| 2048. 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 |
| 2050. ClinicalDocument.documentationOf | |
| Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf |
| 2052. 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 |
| 2054. 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 |
| 2056. 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()) |
| 2058. 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 |
| 2060. 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 |
| 2062. 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 |
| 2064. 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 |
| 2066. 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 |
| 2068. 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 |
| 2070. 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 |
| 2072. 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()) |
| 2074. 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 |
| 2076. 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 |
| 2078. 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()) |
| 2080. 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 |
| 2082. 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 |
| 2084. 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 |
| 2086. 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 |
| 2088. 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 |
| 2090. 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 |
| 2092. 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 |
| 2094. 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 |
| 2096. ClinicalDocument.documentationOf.serviceEvent.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2098. ClinicalDocument.documentationOf.serviceEvent.code | |
| Definition | Drawn from concept domain ActCode |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2100. ClinicalDocument.documentationOf.serviceEvent.effectiveTime | |
| Comments | This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 2102. 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 |
| 2104. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Short | Either @value or low/high should be present, but not both |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2106. 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 |
| 2108. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| Invariants | ts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)ts-should-minute: **SHOULD** be precise to at least the minute ( nullFlavor.exists() or value.toString().length() > 10) |
| 2110. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2112. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2114. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive | |
| Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 2116. 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 |
| 2118. 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 |
| 2120. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| Invariants | ts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)ts-should-minute: **SHOULD** be precise to at least the minute ( nullFlavor.exists() or value.toString().length() > 10) |
| 2122. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2124. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2126. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive | |
| Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 2128. 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..* This element is affected by the following invariants: should-us-performer |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1 |
| 2130. 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 |
| 2132. 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 |
| 2134. 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()) |
| 2136. 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 |
| 2138. 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 |
| 2140. 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 |
| 2142. 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 |
| 2144. 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 |
| 2146. 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 |
| 2148. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode | |
| Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ServiceEventPerformer (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2150. 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 |
| Invariants | should-code-attr: SHOULD contain @code (code.exists()) |
| 2152. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2154. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Care Team Member Function (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element 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 |
| 2156. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 2158. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 2160. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 2162. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 2164. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 2166. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 2168. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 2170. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 2172. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 2174. ClinicalDocument.documentationOf.serviceEvent.performer.time | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 2176. 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()) |
| 2178. 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 |
| 2180. 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 |
| 2182. 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()) |
| 2184. 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 |
| 2186. 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 |
| 2188. 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 |
| 2190. 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 |
| 2192. 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 |
| 2194. 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 |
| 2196. 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 |
| 2198. 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 |
| 2200. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2202. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 2204. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 2206. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 2208. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 2210. 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 nameidentifiedBy. |
| 2212. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code | |
| Comments | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-14842). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2214. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 2216. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 2218. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 2220. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 2222. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 2224. 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 namepatient. |
| 2226. 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. |
| 2228. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument |
| 2230. 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 |
| 2232. 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 |
| 2234. 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 |
| 2236. 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()) |
| 2238. 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 |
| 2240. 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 |
| 2242. 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 |
| 2244. 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 |
| 2246. 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 |
| 2248. 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 |
| 2250. 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 |
| 2252. 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 |
| 2254. 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 |
| 2256. 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 |
| 2258. 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()) |
| 2260. 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 |
| 2262. 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 |
| 2264. 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 |
| 2266. 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 |
| 2268. 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 |
| 2270. 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 |
| 2272. 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 |
| 2274. 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 |
| 2276. 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/IIid |
| Is Modifier | false |
| 2278. 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 |
| 2280. 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 |
| 2282. 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 |
| 2284. 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 |
| 2286. 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 |
| 2288. 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 |
| 2290. 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 |
| 2292. 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 |
| 2294. 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 namevalueSet. |
| 2296. 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 namevalueSetVersion. |
| 2298. 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 |
| 2300. 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 |
| 2302. 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:typeattribute. |
| Label | Translation |
| 2304. 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 |
| 2306. 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 |
| 2308. 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 |
| 2310. 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()) |
| 2312. 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 |
| 2314. 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 |
| 2316. 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 |
| 2318. 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 |
| 2320. 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 |
| 2322. 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 |
| 2324. 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 |
| 2326. 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()) |
| 2328. 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 |
| 2330. 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 |
| 2332. 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()) |
| 2334. 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 |
| 2336. 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 |
| 2338. 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 |
| 2340. 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 |
| 2342. 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 |
| 2344. 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 |
| 2346. 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 |
| 2348. 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 |
| 2350. ClinicalDocument.componentOf.encompassingEncounter.id | |
| Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2352. ClinicalDocument.componentOf.encompassingEncounter.code | |
| Comments | This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Act Encounter Codes (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2354. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime | |
| Comments | This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 2356. 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 nameadmissionReferralSourceCode. |
| 2358. 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 |
| 2360. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty | |
| Definition | The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state. |
| Comments | This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 2362. 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 |
| 2364. 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 |
| 2366. 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()) |
| 2368. 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 |
| 2370. 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 |
| 2372. 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 |
| 2374. 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 |
| 2376. 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 |
| 2378. 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 |
| 2380. 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 |
| 2382. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | |
| Comments | The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
| Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (assignedPerson.exists() or representedOrganization.exists()) |
| 2384. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant |
| 2386. ClinicalDocument.componentOf.encompassingEncounter.location | |
| Definition | The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class). The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow. When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 2388. 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 |
| 2390. 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 |
| 2392. 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()) |
| 2394. 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 |
| 2396. 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 |
| 2398. 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 |
| 2400. 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 |
| 2402. 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 |
| 2404. 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 |
| 2406. 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 |
| 2408. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility |
| 2410. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2412. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 2414. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 2416. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2418. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 2420. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 2422. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 2424. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 2426. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2428. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RoleClassServiceDeliveryLocation (required to http://terminology.hl7.org/ValueSet/v3-RoleClassServiceDeliveryLocation) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | SDLOC |
| 2430. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2432. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy. |
| 2434. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.code | |
| Control | 0..1 |
| Binding | For example codes, see ServiceDeliveryLocationRoleType (example to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2436. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Place |
| 2438. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2440. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 2442. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 2444. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2446. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 2448. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 2450. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 2452. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 2454. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2456. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.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 |
| 2458. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.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 |
| 2460. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.name | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
| 2462. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.addr | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Facility Address |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 2464. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.serviceProviderOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 2466. 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 ( participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()) |
| 2. ClinicalDocument.realmCode | |
| Comments | SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791). |
| Control | 1..1 |
| 4. ClinicalDocument.realmCode.code | |
| Control | 1..? |
| Pattern Value | US |
| 6. ClinicalDocument.typeId | |
| Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361). |
| Control | 1..? |
| 8. ClinicalDocument.typeId.root | |
| Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250). |
| 10. ClinicalDocument.typeId.extension | |
| Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251). |
| 12. ClinicalDocument.templateId | |
| Control | 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: |
| 14. ClinicalDocument.templateId:us-realm | |
| Slice Name | us-realm |
| Control | 1..1 |
| 16. ClinicalDocument.templateId:us-realm.root | |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.1.1 |
| 18. ClinicalDocument.templateId:us-realm.extension | |
| Control | 1..? |
| Pattern Value | 2024-05-01 |
| 20. 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). |
| 22. 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). |
| 24. ClinicalDocument.code.nullFlavor | |
| Control | 0..0 |
| 26. ClinicalDocument.code.code | |
| Control | 1..? |
| 28. ClinicalDocument.code.codeSystem | |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.6.1 |
| 30. 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..? |
| 32. ClinicalDocument.effectiveTime | |
| Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 34. ClinicalDocument.confidentialityCode | |
| 36. ClinicalDocument.confidentialityCode.nullFlavor | |
| Control | 0..0 |
| 38. ClinicalDocument.confidentialityCode.code | |
| Control | 1..? |
| Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926) |
| 40. 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..? |
| 42. ClinicalDocument.setId | |
| Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261). |
| 44. ClinicalDocument.versionNumber | |
| Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264). |
| 46. 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). |
| 48. ClinicalDocument.recordTarget.patientRole | |
| Comments | Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267). |
| 50. ClinicalDocument.recordTarget.patientRole.id | |
| Comments | This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268). |
| 52. ClinicalDocument.recordTarget.patientRole.addr | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Address |
| Comments | This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 54. ClinicalDocument.recordTarget.patientRole.telecom | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Phone Number / Email |
| Control | 1..? |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 56. ClinicalDocument.recordTarget.patientRole.telecom.use | |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 58. ClinicalDocument.recordTarget.patientRole.patient | |
| Comments | This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283). |
| Control | 1..? |
| Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists())4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true ( sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true'))should-maritalStatusCode: SHOULD contain maritalStatusCode ( maritalStatusCode.exists())should-us-languageCommunication: SHOULD contain languageCommunication ( languageCommunication.exists()) |
| 60. ClinicalDocument.recordTarget.patientRole.patient.name | |
| Comments | This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED)) |
| 62. ClinicalDocument.recordTarget.patientRole.patient.birthTime | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured) |
| Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298). |
| Control | 1..? |
| 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) |
| 64. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd | |
| Short | sdtc:deceasedInd |
| Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990). |
| 66. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Date of Death |
| Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988). |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime. |
| 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) |
| 68. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode | |
| Short | SHOULD contain maritalStatusCode |
| Comments | This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303). |
| Binding | The codes SHALL be taken from Marital Status (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212) |
| 70. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode | |
| Comments | This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317). |
| Binding | The codes SHALL be taken from Religious Affiliation (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185) |
| 72. ClinicalDocument.recordTarget.patientRole.patient.raceCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Race - raceCode SHALL contain only the OMB race category; detailed race values go in translation. Additional race categories are conveyed using sdtc:raceCode, following the same pattern (OMB category in root; details in translation). |
| Control | 1..? |
| Binding | The codes SHALL be taken from Race Categories (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.2.575) |
| 74. ClinicalDocument.recordTarget.patientRole.patient.raceCode.translation | |
| Binding | The codes SHOULD be taken from Race Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914) |
| Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. ((code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()) |
| 76. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements. |
| Binding | The codes SHALL be taken from Detailed race including absence reasons. (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.25) |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode. |
| Invariants | sdtc-race-not-detail: When using translation to convey race details, the base code SHALL be a race category. (translation.exists(codeSystem = '2.16.840.1.113883.6.238') implies (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1'))) |
| 78. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.translation | |
| Binding | The codes SHOULD be taken from Race Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914) |
| Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. ((code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()) |
| 80. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity |
| Control | 1..? |
| Binding | The codes SHALL be taken from Ethnicity Categories (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.3) |
| 82. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity |
| Binding | The codes SHALL be taken from Detailed Ethnicity Including Absence Reasons (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.1) |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode. |
| 84. ClinicalDocument.recordTarget.patientRole.patient.guardian | |
| Comments | This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325). |
| 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()) |
| 86. ClinicalDocument.recordTarget.patientRole.patient.guardian.code | |
| Comments | The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-5326). |
| Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1) |
| 88. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr | |
| Comments | The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 90. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom | |
| Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382). |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 92. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use | |
| Comments | The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 94. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson | |
| Comments | The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385). |
| Control | 1..? |
| 96. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name | |
| Comments | This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 98. ClinicalDocument.recordTarget.patientRole.patient.birthplace | |
| Comments | This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395). |
| 100. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place | |
| Comments | The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396). |
| 102. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr | |
| Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397). |
| Control | 1..? |
| Invariants | 4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://terminology.hl7.org/ValueSet/USPS-State')))4537-5403: If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists()) |
| 104. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item | |
| 106. 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) |
| 108. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Preferred Language |
| Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (proficiencyLevelCode.exists())should-preferenceInd: SHOULD contain preferenceInd ( preferenceInd.exists()) |
| 110. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode | |
| Control | 1..? |
| Binding | The codes SHALL be taken from Languages (required to http://terminology.hl7.org/ValueSet/Languages) |
| 112. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode | |
| Comments | The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:4537-5409). |
| Binding | The codes SHALL be taken from LanguageAbilityMode (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249) |
| 114. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode | |
| Short | SHOULD contain proficiencyLevelCode |
| Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:4537-9965). |
| Binding | The codes SHALL be taken from LanguageAbilityProficiency (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199) |
| 116. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd | |
| Short | SHOULD contain preferenceInd |
| Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414). |
| 118. ClinicalDocument.recordTarget.patientRole.providerOrganization | |
| Comments | This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416). |
| 120. ClinicalDocument.recordTarget.patientRole.providerOrganization.id | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417). |
| Control | 1..? |
| 122. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root | |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16820). |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 124. ClinicalDocument.recordTarget.patientRole.providerOrganization.name | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419). |
| Control | 1..? |
| 126. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420). |
| Control | 1..? |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 128. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use | |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7994). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 130. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5422). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 132. 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). |
| 134. ClinicalDocument.author.time | |
| Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 136. ClinicalDocument.author.assignedAuthor | |
| Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448). |
| Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ((assignedPerson | assignedAuthoringDevice).count() = 1)should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) ( id.where(root = '2.16.840.1.113883.4.6'))should-us-code: SHOULD contain code ( code.exists()) |
| 138. ClinicalDocument.author.assignedAuthor.id | |
| Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449). |
| Slicing | This element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 140. ClinicalDocument.author.assignedAuthor.id:npi | |
| Slice Name | npi |
| Control | 0..1 |
| Invariants | should-extension: SHOULD contain extension (extension.exists()) |
| 142. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor | |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| 144. ClinicalDocument.author.assignedAuthor.id:npi.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 146. ClinicalDocument.author.assignedAuthor.id:npi.extension | |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4537-32885). |
| 148. 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). |
| 150. ClinicalDocument.author.assignedAuthor.code.nullFlavor | |
| Control | 0..0 |
| 152. ClinicalDocument.author.assignedAuthor.code.code | |
| Control | 1..? |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| 154. ClinicalDocument.author.assignedAuthor.sdtcSpecialty | |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| 156. ClinicalDocument.author.assignedAuthor.addr | |
| Comments | This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 158. ClinicalDocument.author.assignedAuthor.telecom | |
| Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428). |
| Control | 1..? |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 160. ClinicalDocument.author.assignedAuthor.telecom.use | |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 162. ClinicalDocument.author.assignedAuthor.assignedPerson | |
| Comments | MAY contain assignedPerson |
| 164. ClinicalDocument.author.assignedAuthor.assignedPerson.name | |
| Comments | The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-16789). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 166. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice | |
| Comments | MAY contain assignedAuthoringDevice |
| 168. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName | |
| Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784). |
| Control | 1..? |
| 170. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName | |
| Comments | The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785). |
| Control | 1..? |
| 172. 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). |
| 174. ClinicalDocument.dataEnterer.time | |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 176. ClinicalDocument.dataEnterer.assignedEntity | |
| Comments | The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442). |
| 178. ClinicalDocument.dataEnterer.assignedEntity.id | |
| Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443). |
| 180. ClinicalDocument.dataEnterer.assignedEntity.id.root | |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16821). |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 182. 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). |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| 184. ClinicalDocument.dataEnterer.assignedEntity.sdtcSpecialty | |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| 186. ClinicalDocument.dataEnterer.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5460). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 188. ClinicalDocument.dataEnterer.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466). |
| Control | 1..? |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 190. ClinicalDocument.dataEnterer.assignedEntity.telecom.use | |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7996). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 192. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson | |
| Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469). |
| Control | 1..? |
| 194. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5470). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 196. 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: |
| 198. 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..* |
| 200. ClinicalDocument.informant:provider.assignedEntity | |
| Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002). |
| Control | 1..? |
| 202. 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). |
| 204. ClinicalDocument.informant:provider.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32174). |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| 206. ClinicalDocument.informant:provider.assignedEntity.sdtcSpecialty | |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| 208. ClinicalDocument.informant:provider.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 210. ClinicalDocument.informant:provider.assignedEntity.assignedPerson | |
| Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221). |
| Control | 1..? |
| 212. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 214. ClinicalDocument.informant:provider.relatedEntity | |
| Control | 0..0 |
| 216. 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..* |
| 218. ClinicalDocument.informant:non-provider.assignedEntity | |
| Control | 0..0 |
| 220. ClinicalDocument.informant:non-provider.relatedEntity | |
| Comments | SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356). |
| Control | 1..? |
| 222. 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). |
| 224. ClinicalDocument.custodian.assignedCustodian | |
| Comments | This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520). |
| 226. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization | |
| Comments | This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521). |
| 228. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id | |
| Comments | This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522). |
| 230. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root | |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16822). |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 232. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name | |
| Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524). |
| Control | 1..? |
| 234. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom | |
| Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525). |
| Control | 1..? |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 236. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use | |
| Comments | This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 238. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom | |
| Short | The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization. |
| 240. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr | |
| Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 242. 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). |
| 244. ClinicalDocument.informationRecipient.intendedRecipient | |
| Comments | The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566). |
| 246. ClinicalDocument.informationRecipient.intendedRecipient.id | |
| Comments | This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399). |
| 248. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient | |
| Comments | This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567). |
| 250. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name | |
| Comments | The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5568). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 252. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization | |
| Comments | This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577). |
| 254. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name | |
| Comments | The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578). |
| Control | 1..1 |
| 256. 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). |
| 258. ClinicalDocument.legalAuthenticator.time | |
| Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 260. ClinicalDocument.legalAuthenticator.signatureCode | |
| Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583). |
| 262. 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..? |
| Pattern Value | S |
| 264. 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). |
| 266. ClinicalDocument.legalAuthenticator.assignedEntity | |
| Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585). |
| 268. ClinicalDocument.legalAuthenticator.assignedEntity.id | |
| Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586). |
| 270. ClinicalDocument.legalAuthenticator.assignedEntity.id.root | |
| Short | MAY contain '2.16.840.1.113883.4.6' (NPI) |
| Comments | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823). |
| 272. ClinicalDocument.legalAuthenticator.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-17000). |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| 274. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcSpecialty | |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| 276. ClinicalDocument.legalAuthenticator.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5589). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 278. ClinicalDocument.legalAuthenticator.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595). |
| Control | 1..? |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 280. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use | |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7999). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 282. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson | |
| Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597). |
| Control | 1..? |
| 284. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5598). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 286. ClinicalDocument.authenticator | |
| Short | The authenticator identifies a participant or participants who attest to the accuracy of the information in the document. |
| 288. ClinicalDocument.authenticator.time | |
| Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 290. ClinicalDocument.authenticator.signatureCode | |
| Comments | SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610). |
| 292. 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..? |
| Pattern Value | S |
| 294. 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). |
| 296. ClinicalDocument.authenticator.assignedEntity | |
| Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612). |
| 298. ClinicalDocument.authenticator.assignedEntity.id | |
| Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613). |
| 300. ClinicalDocument.authenticator.assignedEntity.id.root | |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824). |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 302. ClinicalDocument.authenticator.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825). |
| 304. 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). |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| 306. ClinicalDocument.authenticator.assignedEntity.sdtcSpecialty | |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| 308. ClinicalDocument.authenticator.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5616). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 310. ClinicalDocument.authenticator.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622). |
| Control | 1..? |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 312. ClinicalDocument.authenticator.assignedEntity.telecom.use | |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-8000). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| 314. ClinicalDocument.authenticator.assignedEntity.assignedPerson | |
| Comments | This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624). |
| Control | 1..? |
| 316. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 318. 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())4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). ( typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33')) |
| 320. ClinicalDocument.participant.time | |
| Comments | MAY contain zero or one [0..1] time (CONF:4537-10004). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 322. 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). |
| 324. ClinicalDocument.inFulfillmentOf.order | |
| Comments | The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953). |
| 326. ClinicalDocument.inFulfillmentOf.order.id | |
| Comments | This order SHALL contain at least one [1..*] id (CONF:4537-9954). |
| 328. ClinicalDocument.documentationOf | |
| Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835). |
| 330. 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()) |
| 332. ClinicalDocument.documentationOf.serviceEvent.effectiveTime | |
| Comments | This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 334. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low | |
| Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838). |
| Control | 1..? |
| 336. 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). |
| 338. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode | |
| Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840). |
| Binding | The codes SHALL be taken from x_ServiceEventPerformer (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601) |
| 340. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode | |
| Comments | The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818). |
| Invariants | should-code-attr: SHOULD contain @code (code.exists()) |
| 342. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code | |
| Comments | The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889). |
| Binding | The codes SHOULD be taken from Care Team Member Function (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30) |
| 344. ClinicalDocument.documentationOf.serviceEvent.performer.time | |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 346. 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()) |
| 348. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id | |
| Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846). |
| 350. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root | |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847). |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 352. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code | |
| Comments | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-14842). |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| 354. 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 |
| 356. ClinicalDocument.authorization.consent | |
| Comments | SHALL contain exactly one [1..1] consent (CONF:4537-16793). |
| 358. ClinicalDocument.authorization.consent.id | |
| Comments | This consent MAY contain zero or more [0..*] id (CONF:4537-16794). |
| 360. 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). |
| 362. ClinicalDocument.authorization.consent.statusCode | |
| Comments | This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797). |
| 364. 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). |
| 366. 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). |
| 368. 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()) |
| 370. ClinicalDocument.componentOf.encompassingEncounter.id | |
| Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959). |
| Control | 1..? |
| 372. ClinicalDocument.componentOf.encompassingEncounter.code | |
| Comments | This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873). |
| Binding | The codes SHOULD be taken from Act Encounter Codes (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5) |
| 374. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime | |
| Comments | This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 376. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty | |
| Comments | This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391). |
| 378. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | |
| Comments | The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904). |
| Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (assignedPerson.exists() or representedOrganization.exists()) |
| 380. ClinicalDocument.componentOf.encompassingEncounter.location | |
| 382. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility | |
| 384. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location | |
| 386. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.addr | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Facility Address |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ClinicalDocument | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instance of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | 4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (setId.exists() implies versionNumber.exists())4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). ( versionNumber.exists() implies setId.exists())should-legalAuthenticator: SHOULD contain legalAuthenticator ( legalAuthenticator.exists())should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant ( participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()) |
| 2. ClinicalDocument.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 4. ClinicalDocument.classCode | |
| Control | 0..1 |
| Binding | For example codes, see CDAActClass (example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | DOCCLIN |
| 6. ClinicalDocument.moodCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDAActMood (required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | EVN |
| 8. ClinicalDocument.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Comments | SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 10. ClinicalDocument.realmCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 12. ClinicalDocument.realmCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | US |
| 14. ClinicalDocument.realmCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 16. ClinicalDocument.realmCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 18. ClinicalDocument.realmCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 20. ClinicalDocument.realmCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 22. ClinicalDocument.realmCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 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 namevalueSetVersion. |
| 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:typeattribute. |
| Label | Translation |
| 32. ClinicalDocument.typeId | |
| Definition | ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description). |
| Comments | SHALL contain exactly one [1..1] typeId (CONF:4537-5361). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 34. ClinicalDocument.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 36. ClinicalDocument.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 38. ClinicalDocument.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 40. ClinicalDocument.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Comments | This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 42. ClinicalDocument.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251). |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| Fixed Value | POCD_HD000040 |
| 44. ClinicalDocument.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ClinicalDocument.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. ClinicalDocument.templateId:us-realm | |
| Slice Name | us-realm |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 48. ClinicalDocument.templateId:us-realm.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 50. ClinicalDocument.templateId:us-realm.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 52. ClinicalDocument.templateId:us-realm.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 54. ClinicalDocument.templateId:us-realm.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.1.1 |
| 56. ClinicalDocument.templateId:us-realm.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| Pattern Value | 2024-05-01 |
| 58. ClinicalDocument.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). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 60. ClinicalDocument.sdtcCategory | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namecategory. |
| 62. 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 |
| 64. ClinicalDocument.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 66. ClinicalDocument.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 68. ClinicalDocument.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| Pattern Value | 2.16.840.1.113883.6.1 |
| 70. ClinicalDocument.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 72. 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 |
| 74. ClinicalDocument.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 76. 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 namevalueSet. |
| 78. 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 namevalueSetVersion. |
| 80. 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 |
| 82. 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 |
| 84. 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:typeattribute. |
| Label | Translation |
| 86. 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 |
| 88. 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 namestatusCode. |
| 90. ClinicalDocument.effectiveTime | |
| Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 92. ClinicalDocument.confidentialityCode | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 94. 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 |
| 96. ClinicalDocument.confidentialityCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from HL7 BasicConfidentialityKind (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 98. 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 |
| 100. 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 |
| 102. 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 |
| 104. 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 |
| 106. 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 namevalueSet. |
| 108. 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 namevalueSetVersion. |
| 110. 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 |
| 112. 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 |
| 114. 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:typeattribute. |
| Label | Translation |
| 116. 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 |
| 118. ClinicalDocument.setId | |
| Comments | MAY contain zero or one [0..1] setId (CONF:4537-5261). |
| Control | 0..1 This element is affected by the following invariants: 4537-6380, 4537-6387 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 120. ClinicalDocument.versionNumber | |
| Comments | MAY contain zero or one [0..1] versionNumber (CONF:4537-5264). |
| Control | 0..1 This element is affected by the following invariants: 4537-6380, 4537-6387 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 122. ClinicalDocument.copyTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 124. 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 |
| 126. 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 |
| 128. 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 |
| 130. 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()) |
| 132. 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 |
| 134. 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 |
| 136. 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 |
| 138. 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 |
| 140. 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 |
| 142. 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 |
| 144. 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 |
| 146. 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 |
| 148. 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 |
| 150. 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 |
| 152. 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 |
| 154. 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()) |
| 156. 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 |
| 158. 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 |
| 160. 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 |
| 162. 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 |
| 164. 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 |
| 166. 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 |
| 168. 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 |
| 170. 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 |
| 172. 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 nameidentifiedBy. |
| 174. ClinicalDocument.recordTarget.patientRole.addr | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Address |
| Comments | This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 176. ClinicalDocument.recordTarget.patientRole.telecom | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Phone Number / Email |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 178. 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 |
| 180. 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. |
| 182. 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:typeattribute. |
| Label | Useable Period |
| 184. ClinicalDocument.recordTarget.patientRole.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 186. 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 |
| Invariants | 4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists())4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true ( sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true'))should-maritalStatusCode: SHOULD contain maritalStatusCode ( maritalStatusCode.exists())should-us-languageCommunication: SHOULD contain languageCommunication ( languageCommunication.exists()) |
| 188. 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 |
| 190. 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 |
| 192. 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()) |
| 194. 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 |
| 196. 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 |
| 198. 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 |
| 200. 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 |
| 202. 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 |
| 204. 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 |
| 206. 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 |
| 208. 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 |
| 210. ClinicalDocument.recordTarget.patientRole.patient.id | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 212. ClinicalDocument.recordTarget.patientRole.patient.name | |
| Comments | This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED)) |
| 214. 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 namedesc. |
| 216. 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 |
| 218. ClinicalDocument.recordTarget.patientRole.patient.birthTime | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured) |
| Comments | This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| Invariants | ts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)ts-should-day: **SHOULD** be precise to at least the day ( nullFlavor.exists() or value.toString().length() >= 10) |
| 220. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd | |
| Short | sdtc:deceasedInd |
| Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd. |
| 222. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Date of Death |
| Comments | This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime. |
| 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) |
| 224. 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 namemultipleBirthInd. |
| 226. 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 namemultipleBirthOrderNumber. |
| 228. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode | |
| Short | Added:SHOULD contain maritalStatusCode |
| Comments | This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303). |
| Control | 0..1 This element is affected by the following invariants: should-maritalStatusCode |
| Binding | The codes SHALL be taken from Marital Status (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 230. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode | |
| Comments | This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Religious Affiliation (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 232. ClinicalDocument.recordTarget.patientRole.patient.raceCode | |
| Short | Changed:𝗨𝗦𝗖𝗗𝗜: Race - raceCode SHALL contain only the OMB race category; detailed race values go in translation. Additional race categories are conveyed using sdtc:raceCode, following the same pattern (OMB category in root; details in translation). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Race Categories (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.2.575) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 234. ClinicalDocument.recordTarget.patientRole.patient.raceCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 236. ClinicalDocument.recordTarget.patientRole.patient.raceCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 238. ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 240. ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 242. ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 244. ClinicalDocument.recordTarget.patientRole.patient.raceCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 246. ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 248. ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 250. ClinicalDocument.recordTarget.patientRole.patient.raceCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 252. ClinicalDocument.recordTarget.patientRole.patient.raceCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 254. ClinicalDocument.recordTarget.patientRole.patient.raceCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Binding | The codes SHOULD be taken from Race Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. ((code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()) |
| 256. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements. |
| Control | 0..* |
| Binding | The codes SHALL be taken from Detailed race including absence reasons. (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.25) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode. |
| Invariants | sdtc-race-not-detail: When using translation to convey race details, the base code SHALL be a race category. (translation.exists(codeSystem = '2.16.840.1.113883.6.238') implies (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1'))) |
| 258. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 260. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 0..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 262. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 264. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 266. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 268. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 270. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 272. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 274. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 276. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 278. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Binding | The codes SHOULD be taken from Race Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| Invariants | race-not-category: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements. ((code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()) |
| 280. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Ethnicity Categories (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.3) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 282. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Ethnicity |
| Control | 0..* |
| Binding | The codes SHALL be taken from Detailed Ethnicity Including Absence Reasons (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.1) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode. |
| 284. ClinicalDocument.recordTarget.patientRole.patient.guardian | |
| Comments | This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian |
| 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()) |
| 286. 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 |
| 288. 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 |
| 290. 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()) |
| 292. 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 |
| 294. 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 |
| 296. 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 |
| 298. 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 |
| 300. 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 |
| 302. 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 |
| 304. 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 |
| 306. ClinicalDocument.recordTarget.patientRole.patient.guardian.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 308. 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 nameidentifiedBy. |
| 310. ClinicalDocument.recordTarget.patientRole.patient.guardian.code | |
| Comments | The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-5326). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Personal And Legal Relationship Role Type (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 312. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr | |
| Comments | The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 314. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom | |
| Comments | The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 316. 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 |
| 318. 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. |
| 320. 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:typeattribute. |
| Label | Useable Period |
| 322. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 324. 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 |
| 326. 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 |
| 328. 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 |
| 330. 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()) |
| 332. 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 |
| 334. 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 |
| 336. 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 |
| 338. 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 |
| 340. 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 |
| 342. 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 |
| 344. 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 |
| 346. 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 |
| 348. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name | |
| Comments | This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 350. 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 namedesc. |
| 352. 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 nameasPatientRelationship. |
| 354. 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 |
| 356. 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 |
| 358. 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()) |
| 360. 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 |
| 362. 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 |
| 364. 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 |
| 366. 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 |
| 368. 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 |
| 370. 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 |
| 372. 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 |
| 374. 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 |
| 376. 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. |
| 378. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 380. 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 |
| 382. 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 |
| 384. 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 |
| 386. 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()) |
| 388. 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 |
| 390. 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 |
| 392. 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 |
| 394. 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 |
| 396. 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 |
| 398. 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 |
| 400. 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 |
| 402. 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 |
| 404. 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 |
| 406. 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 |
| 408. 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()) |
| 410. 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 |
| 412. 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 |
| 414. 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 |
| 416. 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 |
| 418. 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 |
| 420. 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 |
| 422. 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 |
| 424. 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 |
| 426. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
| 428. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr | |
| Comments | This place SHALL contain exactly one [1..1] addr (CONF:4537-5397). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| Invariants | 4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://terminology.hl7.org/ValueSet/USPS-State')))4537-5403: If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists()) |
| 430. 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 |
| 432. 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 |
| 434. 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 |
| 436. 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) |
| 438. 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) |
| 440. 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 |
| 442. 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 |
| 444. 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 |
| 446. 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 |
| 448. 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. |
| 450. 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 |
| 452. 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) |
| 454. 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 |
| 456. 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 |
| 458. 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 |
| 460. 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 |
| 462. 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. |
| 464. 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 |
| 466. 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) |
| 468. 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 |
| 470. 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 |
| 472. 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 |
| 474. 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 |
| 476. 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. |
| 478. 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 |
| 480. 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) |
| 482. 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 |
| 484. 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 |
| 486. 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 |
| 488. 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 |
| 490. 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. |
| 492. 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 |
| 494. 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) |
| 496. 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 |
| 498. 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 |
| 500. 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 |
| 502. 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 |
| 504. 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. |
| 506. 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 |
| 508. 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) |
| 510. 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 |
| 512. 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 |
| 514. 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 |
| 516. 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 |
| 518. 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. |
| 520. 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 |
| 522. 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) |
| 524. 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 |
| 526. 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 |
| 528. 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 |
| 530. 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 |
| 532. 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. |
| 534. 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 |
| 536. 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) |
| 538. 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 |
| 540. 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 |
| 542. 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 |
| 544. 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 |
| 546. 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. |
| 548. 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 |
| 550. 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) |
| 552. 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 |
| 554. 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 |
| 556. 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 |
| 558. 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 |
| 560. 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. |
| 562. 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 |
| 564. 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) |
| 566. 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 |
| 568. 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 |
| 570. 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 |
| 572. 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 |
| 574. 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. |
| 576. 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 |
| 578. 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) |
| 580. 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 |
| 582. 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 |
| 584. 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 |
| 586. 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 |
| 588. 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. |
| 590. 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 |
| 592. 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) |
| 594. 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 |
| 596. 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 |
| 598. 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 |
| 600. 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 |
| 602. 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. |
| 604. 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 |
| 606. 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) |
| 608. 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 |
| 610. 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 |
| 612. 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 |
| 614. 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 |
| 616. 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. |
| 618. 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 |
| 620. 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) |
| 622. 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 |
| 624. 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 |
| 626. 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 |
| 628. 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 |
| 630. 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. |
| 632. 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 |
| 634. 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) |
| 636. 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 |
| 638. 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 |
| 640. 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 |
| 642. 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 |
| 644. 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. |
| 646. 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 |
| 648. 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) |
| 650. 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 |
| 652. 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 |
| 654. 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 |
| 656. 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 |
| 658. 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. |
| 660. 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 |
| 662. 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) |
| 664. 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 |
| 666. 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 |
| 668. 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 |
| 670. 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 |
| 672. 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. |
| 674. 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 |
| 676. 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) |
| 678. 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 |
| 680. 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 |
| 682. 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 |
| 684. 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 |
| 686. 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. |
| 688. 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 |
| 690. 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) |
| 692. 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 |
| 694. 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 |
| 696. 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 |
| 698. 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 |
| 700. 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. |
| 702. 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 |
| 704. 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) |
| 706. 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 |
| 708. 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 |
| 710. 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 |
| 712. 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 |
| 714. 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. |
| 716. 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 |
| 718. 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) |
| 720. 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 |
| 722. 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 |
| 724. 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 |
| 726. 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 |
| 728. 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. |
| 730. 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 |
| 732. 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) |
| 734. 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 |
| 736. 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 |
| 738. 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 |
| 740. 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 |
| 742. 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. |
| 744. 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 |
| 746. 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) |
| 748. 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 |
| 750. 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 |
| 752. 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 |
| 754. 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 |
| 756. 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. |
| 758. 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 |
| 760. 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) |
| 762. 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 |
| 764. 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 |
| 766. 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 |
| 768. 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 |
| 770. 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. |
| 772. 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 |
| 774. 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) |
| 776. 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 |
| 778. 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 |
| 780. 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 |
| 782. 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 |
| 784. 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. |
| 786. 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 |
| 788. 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) |
| 790. 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 |
| 792. 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 |
| 794. 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 |
| 796. 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 |
| 798. 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. |
| 800. 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 |
| 802. 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) |
| 804. 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 |
| 806. 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 |
| 808. 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 |
| 810. 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 |
| 812. 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. |
| 814. 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 |
| 816. 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. |
| 818. 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:typeattribute. |
| Label | Useable Period |
| 820. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Preferred Language |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication |
| Invariants | should-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (proficiencyLevelCode.exists())should-preferenceInd: SHOULD contain preferenceInd ( preferenceInd.exists()) |
| 822. 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 |
| 824. 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 |
| 826. 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()) |
| 828. 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 |
| 830. 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 |
| 832. 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 |
| 834. 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 |
| 836. 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 |
| 838. 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 |
| 840. 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 |
| 842. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode | |
| Comments | The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:4537-5409). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from LanguageAbilityMode (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 844. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode | |
| Short | Added:SHOULD contain proficiencyLevelCode |
| Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:4537-9965). |
| Control | 0..1 This element is affected by the following invariants: should-proficiencyLevelCode |
| Binding | The codes SHALL be taken from LanguageAbilityProficiency (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 846. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd | |
| Short | Added:SHOULD contain preferenceInd |
| Comments | The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414). |
| Control | 0..1 This element is affected by the following invariants: should-preferenceInd |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 848. 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 |
| 850. 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 |
| 852. 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 |
| 854. 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()) |
| 856. 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 |
| 858. 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 |
| 860. 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 |
| 862. 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 |
| 864. 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 |
| 866. 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 |
| 868. 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 |
| 870. 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 |
| 872. 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 |
| 874. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 876. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 878. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 880. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16820). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 882. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 884. 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 |
| 886. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 888. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 890. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value | |
| Control | 0..1 |
| Type | url(url: Universal Resource Locator) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 892. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod | |
| Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
| Control | 0..* |
| Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Useable Period |
| 894. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7994). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 896. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr | |
| Comments | The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5422). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 898. 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 |
| 900. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf |
| 902. 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 |
| 904. 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 |
| 906. 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 |
| 908. 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()) |
| 910. 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 |
| 912. 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 |
| 914. 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 |
| 916. 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 |
| 918. 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 |
| 920. 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 |
| 922. 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 |
| 924. 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 |
| 926. ClinicalDocument.author.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 928. ClinicalDocument.author.time | |
| Comments | Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 930. ClinicalDocument.author.assignedAuthor | |
| Comments | Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor |
| Invariants | 4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ((assignedPerson | assignedAuthoringDevice).count() = 1)should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) ( id.where(root = '2.16.840.1.113883.4.6'))should-us-code: SHOULD contain code ( code.exists()) |
| 932. 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 |
| 934. 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 |
| 936. 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()) |
| 938. 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 |
| 940. 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 |
| 942. 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 |
| 944. 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 |
| 946. 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 |
| 948. 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 |
| 950. 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 |
| 952. ClinicalDocument.author.assignedAuthor.id | |
| Comments | This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 954. ClinicalDocument.author.assignedAuthor.id:npi | |
| Slice Name | npi |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | should-extension: SHOULD contain extension (extension.exists()) |
| 956. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Short | If NPI is unknown, set @nullFlavor to UNK |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 958. ClinicalDocument.author.assignedAuthor.id:npi.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 960. ClinicalDocument.author.assignedAuthor.id:npi.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 962. ClinicalDocument.author.assignedAuthor.id:npi.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.4.6 |
| 964. ClinicalDocument.author.assignedAuthor.id:npi.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHOULD contain zero or one [0..1] @extension (CONF:4537-32885). |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 966. 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 nameidentifiedBy. |
| 968. 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 |
| 970. 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 |
| 972. ClinicalDocument.author.assignedAuthor.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 974. 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 |
| 976. 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 |
| 978. 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 |
| 980. 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 |
| 982. 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 namevalueSet. |
| 984. 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 namevalueSetVersion. |
| 986. 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 |
| 988. 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 |
| 990. 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:typeattribute. |
| Label | Translation |
| 992. ClinicalDocument.author.assignedAuthor.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 994. ClinicalDocument.author.assignedAuthor.addr | |
| Comments | This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 996. ClinicalDocument.author.assignedAuthor.telecom | |
| Comments | This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 998. 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 |
| 1000. 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. |
| 1002. 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:typeattribute. |
| Label | Useable Period |
| 1004. ClinicalDocument.author.assignedAuthor.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1006. ClinicalDocument.author.assignedAuthor.assignedPerson | |
| Comments | MAY contain assignedPerson |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 1008. 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 |
| 1010. 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 |
| 1012. 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()) |
| 1014. 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 |
| 1016. 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 |
| 1018. 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 |
| 1020. 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 |
| 1022. 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 |
| 1024. 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 |
| 1026. 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 |
| 1028. 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 |
| 1030. ClinicalDocument.author.assignedAuthor.assignedPerson.name | |
| Comments | The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-16789). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 1032. 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 namedesc. |
| 1034. 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 nameasPatientRelationship. |
| 1036. 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 |
| 1038. 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 |
| 1040. 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()) |
| 1042. 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 |
| 1044. 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 |
| 1046. 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 |
| 1048. 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 |
| 1050. 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 |
| 1052. 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 |
| 1054. 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 |
| 1056. 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 |
| 1058. 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. |
| 1060. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice | |
| Comments | MAY contain assignedAuthoringDevice |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice |
| 1062. 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 |
| 1064. 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 |
| 1066. 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()) |
| 1068. 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 |
| 1070. 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 |
| 1072. 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 |
| 1074. 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 |
| 1076. 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 |
| 1078. 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 |
| 1080. 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 |
| 1082. 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 |
| 1084. 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 |
| 1086. 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 |
| 1088. 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 |
| 1090. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity |
| 1092. ClinicalDocument.author.assignedAuthor.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1094. 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 |
| 1096. 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 |
| 1098. 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 |
| 1100. 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()) |
| 1102. 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 |
| 1104. 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 |
| 1106. 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 |
| 1108. 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 |
| 1110. 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 |
| 1112. 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 |
| 1114. 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 |
| 1116. 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 |
| 1118. ClinicalDocument.dataEnterer.time | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 1120. 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 |
| 1122. 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 |
| 1124. 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 |
| 1126. 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()) |
| 1128. 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 |
| 1130. 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 |
| 1132. 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 |
| 1134. 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 |
| 1136. 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 |
| 1138. 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 |
| 1140. 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 |
| 1142. 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 |
| 1144. ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1146. ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1148. ClinicalDocument.dataEnterer.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1150. ClinicalDocument.dataEnterer.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16821). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 1152. ClinicalDocument.dataEnterer.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1154. 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 nameidentifiedBy. |
| 1156. ClinicalDocument.dataEnterer.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32173). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1158. ClinicalDocument.dataEnterer.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1160. ClinicalDocument.dataEnterer.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5460). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1162. ClinicalDocument.dataEnterer.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1164. 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 |
| 1166. 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. |
| 1168. 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:typeattribute. |
| Label | Useable Period |
| 1170. ClinicalDocument.dataEnterer.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7996). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1172. 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 |
| 1174. 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 |
| 1176. 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 |
| 1178. 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()) |
| 1180. 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 |
| 1182. 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 |
| 1184. 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 |
| 1186. 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 |
| 1188. 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 |
| 1190. 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 |
| 1192. 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 |
| 1194. 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 |
| 1196. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5470). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 1198. 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 namedesc. |
| 1200. 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 nameasPatientRelationship. |
| 1202. 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 |
| 1204. 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 |
| 1206. 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()) |
| 1208. 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 |
| 1210. 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 |
| 1212. 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 |
| 1214. 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 |
| 1216. 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 |
| 1218. 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 |
| 1220. 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 |
| 1222. 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 |
| 1224. 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. |
| 1226. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1228. 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 namepatient. |
| 1230. 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. |
| 1232. 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: |
| 1234. 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 |
| 1236. 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 |
| 1238. 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 |
| 1240. 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()) |
| 1242. 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 |
| 1244. 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 |
| 1246. 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 |
| 1248. 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 |
| 1250. 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 |
| 1252. 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 |
| 1254. 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 |
| 1256. 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 |
| 1258. 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 |
| 1260. 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 |
| 1262. 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 |
| 1264. 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()) |
| 1266. 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 |
| 1268. 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 |
| 1270. 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 |
| 1272. 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 |
| 1274. 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 |
| 1276. 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 |
| 1278. 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 |
| 1280. 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 |
| 1282. 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 nameidentifiedBy. |
| 1284. ClinicalDocument.informant:provider.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32174). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1286. ClinicalDocument.informant:provider.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1288. ClinicalDocument.informant:provider.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1290. ClinicalDocument.informant:provider.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 1292. 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 |
| 1294. 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 |
| 1296. 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 |
| 1298. 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()) |
| 1300. 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 |
| 1302. 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 |
| 1304. 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 |
| 1306. 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 |
| 1308. 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 |
| 1310. 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 |
| 1312. 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 |
| 1314. 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 |
| 1316. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 1318. 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 namedesc. |
| 1320. 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 nameasPatientRelationship. |
| 1322. 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 |
| 1324. 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 |
| 1326. 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()) |
| 1328. 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 |
| 1330. 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 |
| 1332. 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 |
| 1334. 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 |
| 1336. 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 |
| 1338. 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 |
| 1340. 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 |
| 1342. 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 |
| 1344. 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. |
| 1346. ClinicalDocument.informant:provider.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1348. 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 namepatient. |
| 1350. 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. |
| 1352. ClinicalDocument.informant:provider.relatedEntity | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity |
| 1354. 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 |
| 1356. 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 |
| 1358. 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 |
| 1360. 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()) |
| 1362. 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 |
| 1364. 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 |
| 1366. 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 |
| 1368. 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 |
| 1370. 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 |
| 1372. 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 |
| 1374. 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 |
| 1376. 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 |
| 1378. ClinicalDocument.informant:non-provider.assignedEntity | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
| 1380. 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 |
| 1382. 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 |
| 1384. 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 |
| 1386. 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 |
| 1388. 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()) |
| 1390. 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 |
| 1392. 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 |
| 1394. 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 |
| 1396. 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 |
| 1398. 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 |
| 1400. 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 |
| 1402. 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 |
| 1404. 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 |
| 1406. 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 |
| 1408. 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 |
| 1410. 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()) |
| 1412. 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 |
| 1414. 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 |
| 1416. 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 |
| 1418. 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 |
| 1420. 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 |
| 1422. 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 |
| 1424. 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 |
| 1426. 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 |
| 1428. 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 |
| 1430. 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 |
| 1432. 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()) |
| 1434. 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 |
| 1436. 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 |
| 1438. 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 |
| 1440. 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 |
| 1442. 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 |
| 1444. 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 |
| 1446. 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 |
| 1448. 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 |
| 1450. 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 |
| 1452. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1454. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1456. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1458. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16822). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 1460. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1462. 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 |
| 1464. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom | |
| Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1466. 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 |
| 1468. 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. |
| 1470. 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:typeattribute. |
| Label | Useable Period |
| 1472. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1474. 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 nametelecom. |
| 1476. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr | |
| Comments | This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1478. 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 |
| 1480. 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 |
| 1482. 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 |
| 1484. 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()) |
| 1486. 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 |
| 1488. 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 |
| 1490. 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 |
| 1492. 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 |
| 1494. 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 |
| 1496. 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 |
| 1498. 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 |
| 1500. 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 |
| 1502. 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 |
| 1504. 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 |
| 1506. 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()) |
| 1508. 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 |
| 1510. 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 |
| 1512. 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 |
| 1514. 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 |
| 1516. 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 |
| 1518. 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 |
| 1520. 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 |
| 1522. 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 |
| 1524. 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 nameidentifiedBy. |
| 1526. ClinicalDocument.informationRecipient.intendedRecipient.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 1528. ClinicalDocument.informationRecipient.intendedRecipient.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 1530. 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 |
| 1532. 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 |
| 1534. 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 |
| 1536. 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()) |
| 1538. 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 |
| 1540. 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 |
| 1542. 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 |
| 1544. 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 |
| 1546. 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 |
| 1548. 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 |
| 1550. 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 |
| 1552. 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 |
| 1554. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name | |
| Comments | The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5568). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 1556. 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 namedesc. |
| 1558. 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 nameasPatientRelationship. |
| 1560. 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 |
| 1562. 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 |
| 1564. 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()) |
| 1566. 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 |
| 1568. 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 |
| 1570. 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 |
| 1572. 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 |
| 1574. 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 |
| 1576. 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 |
| 1578. 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 |
| 1580. 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 |
| 1582. 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. |
| 1584. 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 |
| 1586. 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 |
| 1588. 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 |
| 1590. 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()) |
| 1592. 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 |
| 1594. 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 |
| 1596. 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 |
| 1598. 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 |
| 1600. 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 |
| 1602. 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 |
| 1604. 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 |
| 1606. 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 |
| 1608. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 1610. 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 |
| 1612. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 1614. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 1616. 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 |
| 1618. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf |
| 1620. 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 This element is affected by the following invariants: should-legalAuthenticator |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator |
| 1622. 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 |
| 1624. 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 |
| 1626. 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()) |
| 1628. 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 |
| 1630. 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 |
| 1632. 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 |
| 1634. 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 |
| 1636. 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 |
| 1638. 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 |
| 1640. 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 |
| 1642. 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 |
| 1644. ClinicalDocument.legalAuthenticator.time | |
| Comments | The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 1646. 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') |
| 1648. 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 |
| 1650. ClinicalDocument.legalAuthenticator.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5584). |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | S |
| 1652. 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 |
| 1654. 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 |
| 1656. 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 |
| 1658. 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 |
| 1660. 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 namevalueSet. |
| 1662. 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 namevalueSetVersion. |
| 1664. 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 |
| 1666. 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 |
| 1668. 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:typeattribute. |
| Label | Translation |
| 1670. 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 namesignatureText. |
| 1672. 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 |
| 1674. 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 |
| 1676. 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 |
| 1678. 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()) |
| 1680. 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 |
| 1682. 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 |
| 1684. 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 |
| 1686. 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 |
| 1688. 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 |
| 1690. 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 |
| 1692. 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 |
| 1694. 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 |
| 1696. ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1698. ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1700. ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1702. ClinicalDocument.legalAuthenticator.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Short | MAY contain '2.16.840.1.113883.4.6' (NPI) |
| Comments | Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| 1704. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1706. 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 nameidentifiedBy. |
| 1708. ClinicalDocument.legalAuthenticator.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-17000). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1710. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1712. ClinicalDocument.legalAuthenticator.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5589). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1714. ClinicalDocument.legalAuthenticator.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1716. 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 |
| 1718. 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. |
| 1720. 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:typeattribute. |
| Label | Useable Period |
| 1722. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7999). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1724. 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 |
| 1726. 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 |
| 1728. 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 |
| 1730. 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()) |
| 1732. 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 |
| 1734. 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 |
| 1736. 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 |
| 1738. 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 |
| 1740. 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 |
| 1742. 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 |
| 1744. 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 |
| 1746. 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 |
| 1748. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5598). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 1750. 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 namedesc. |
| 1752. 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 nameasPatientRelationship. |
| 1754. 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 |
| 1756. 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 |
| 1758. 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()) |
| 1760. 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 |
| 1762. 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 |
| 1764. 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 |
| 1766. 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 |
| 1768. 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 |
| 1770. 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 |
| 1772. 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 |
| 1774. 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 |
| 1776. 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. |
| 1778. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1780. 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 namepatient. |
| 1782. 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. |
| 1784. 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 |
| 1786. 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 |
| 1788. 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 |
| 1790. 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()) |
| 1792. 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 |
| 1794. 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 |
| 1796. 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 |
| 1798. 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 |
| 1800. 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 |
| 1802. 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 |
| 1804. 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 |
| 1806. ClinicalDocument.authenticator.time | |
| Comments | SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time) |
| 1808. 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') |
| 1810. 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 |
| 1812. ClinicalDocument.authenticator.signatureCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | This signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5611). |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | S |
| 1814. 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 |
| 1816. 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 |
| 1818. 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 |
| 1820. 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 |
| 1822. 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 namevalueSet. |
| 1824. 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 namevalueSetVersion. |
| 1826. 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 |
| 1828. 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 |
| 1830. 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:typeattribute. |
| Label | Translation |
| 1832. 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 namesignatureText. |
| 1834. 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 |
| 1836. 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 |
| 1838. 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 |
| 1840. 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()) |
| 1842. 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 |
| 1844. 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 |
| 1846. 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 |
| 1848. 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 |
| 1850. 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 |
| 1852. 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 |
| 1854. 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 |
| 1856. 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 |
| 1858. ClinicalDocument.authenticator.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 1860. ClinicalDocument.authenticator.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 1862. ClinicalDocument.authenticator.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 1864. ClinicalDocument.authenticator.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 1866. ClinicalDocument.authenticator.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 1868. 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 nameidentifiedBy. |
| 1870. ClinicalDocument.authenticator.assignedEntity.code | |
| Comments | This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825). |
| 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 |
| 1872. 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 |
| 1874. ClinicalDocument.authenticator.assignedEntity.code.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-16826). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| 1876. 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 |
| 1878. 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 |
| 1880. 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 |
| 1882. 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 |
| 1884. 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 namevalueSet. |
| 1886. 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 namevalueSetVersion. |
| 1888. 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 |
| 1890. 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 |
| 1892. 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:typeattribute. |
| Label | Translation |
| 1894. ClinicalDocument.authenticator.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 1896. ClinicalDocument.authenticator.assignedEntity.addr | |
| Comments | This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5616). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 1898. ClinicalDocument.authenticator.assignedEntity.telecom | |
| Comments | This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| Invariants | should-use: SHOULD contain @use (nullFlavor.exists() or use.exists()) |
| 1900. 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 |
| 1902. 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. |
| 1904. 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:typeattribute. |
| Label | Useable Period |
| 1906. ClinicalDocument.authenticator.assignedEntity.telecom.use | |
| Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
| Comments | Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-8000). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Telecom Use (US Realm Header) (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Use Code |
| 1908. 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 |
| 1910. 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 |
| 1912. 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 |
| 1914. 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()) |
| 1916. 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 |
| 1918. 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 |
| 1920. 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 |
| 1922. 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 |
| 1924. 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 |
| 1926. 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 |
| 1928. 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 |
| 1930. 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 |
| 1932. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name | |
| Comments | This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED)) |
| 1934. 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 namedesc. |
| 1936. 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 nameasPatientRelationship. |
| 1938. 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 |
| 1940. 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 |
| 1942. 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()) |
| 1944. 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 |
| 1946. 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 |
| 1948. 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 |
| 1950. 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 |
| 1952. 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 |
| 1954. 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 |
| 1956. 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 |
| 1958. 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 |
| 1960. 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. |
| 1962. ClinicalDocument.authenticator.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 1964. 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 namepatient. |
| 1966. 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. |
| 1968. 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())4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). ( typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33')) |
| 1970. 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 |
| 1972. 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 |
| 1974. 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()) |
| 1976. 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 |
| 1978. 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 |
| 1980. 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 |
| 1982. 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 |
| 1984. 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 |
| 1986. 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 |
| 1988. 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. |
| 1990. 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 |
| 1992. ClinicalDocument.participant.functionCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 1994. ClinicalDocument.participant.time | |
| Comments | MAY contain zero or one [0..1] time (CONF:4537-10004). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 1996. ClinicalDocument.participant.associatedEntity | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity |
| 1998. 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 |
| 2000. 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 |
| 2002. 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 |
| 2004. 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()) |
| 2006. 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 |
| 2008. 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 |
| 2010. 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 |
| 2012. 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 |
| 2014. 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 |
| 2016. 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 |
| 2018. 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 |
| 2020. 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 |
| 2022. 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 |
| 2024. 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 |
| 2026. 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()) |
| 2028. 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 |
| 2030. 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 |
| 2032. 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 |
| 2034. 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 |
| 2036. 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 |
| 2038. 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 |
| 2040. 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 |
| 2042. 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 |
| 2044. 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 |
| 2046. 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 |
| 2048. 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 |
| 2050. ClinicalDocument.documentationOf | |
| Comments | MAY contain zero or more [0..*] documentationOf (CONF:4537-14835). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf |
| 2052. 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 |
| 2054. 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 |
| 2056. 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()) |
| 2058. 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 |
| 2060. 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 |
| 2062. 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 |
| 2064. 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 |
| 2066. 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 |
| 2068. 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 |
| 2070. 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 |
| 2072. 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()) |
| 2074. 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 |
| 2076. 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 |
| 2078. 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()) |
| 2080. 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 |
| 2082. 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 |
| 2084. 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 |
| 2086. 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 |
| 2088. 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 |
| 2090. 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 |
| 2092. 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 |
| 2094. 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 |
| 2096. ClinicalDocument.documentationOf.serviceEvent.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2098. ClinicalDocument.documentationOf.serviceEvent.code | |
| Definition | Drawn from concept domain ActCode |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2100. ClinicalDocument.documentationOf.serviceEvent.effectiveTime | |
| Comments | This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 2102. 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 |
| 2104. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Short | Either @value or low/high should be present, but not both |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2106. 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 |
| 2108. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| Invariants | ts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)ts-should-minute: **SHOULD** be precise to at least the minute ( nullFlavor.exists() or value.toString().length() > 10) |
| 2110. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2112. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2114. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive | |
| Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 2116. 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 |
| 2118. 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 |
| 2120. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| Invariants | ts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)ts-should-minute: **SHOULD** be precise to at least the minute ( nullFlavor.exists() or value.toString().length() > 10) |
| 2122. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2124. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2126. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive | |
| Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 2128. 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..* This element is affected by the following invariants: should-us-performer |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer1 |
| 2130. 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 |
| 2132. 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 |
| 2134. 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()) |
| 2136. 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 |
| 2138. 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 |
| 2140. 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 |
| 2142. 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 |
| 2144. 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 |
| 2146. 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 |
| 2148. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode | |
| Comments | The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from x_ServiceEventPerformer (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 2150. 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 |
| Invariants | should-code-attr: SHOULD contain @code (code.exists()) |
| 2152. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2154. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code | |
| Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
| Comments | The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Care Team Member Function (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element 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 |
| 2156. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| 2158. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 2160. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 2162. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 2164. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 2166. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.sdtcValueSetVersion | |
| Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 2168. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 2170. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 2172. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 2174. ClinicalDocument.documentationOf.serviceEvent.performer.time | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 2176. 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()) |
| 2178. 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 |
| 2180. 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 |
| 2182. 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()) |
| 2184. 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 |
| 2186. 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 |
| 2188. 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 |
| 2190. 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 |
| 2192. 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 |
| 2194. 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 |
| 2196. 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 |
| 2198. 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 |
| 2200. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2202. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 2204. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 2206. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847). |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Invariants | should-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6') |
| 2208. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 2210. 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 nameidentifiedBy. |
| 2212. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code | |
| Comments | This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-14842). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2214. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcSpecialty | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namespecialty. |
| 2216. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 2218. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 2220. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 2222. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 2224. 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 namepatient. |
| 2226. 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. |
| 2228. ClinicalDocument.relatedDocument | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument |
| 2230. 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 |
| 2232. 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 |
| 2234. 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 |
| 2236. 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()) |
| 2238. 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 |
| 2240. 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 |
| 2242. 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 |
| 2244. 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 |
| 2246. 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 |
| 2248. 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 |
| 2250. 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 |
| 2252. 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 |
| 2254. 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 |
| 2256. 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 |
| 2258. 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()) |
| 2260. 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 |
| 2262. 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 |
| 2264. 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 |
| 2266. 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 |
| 2268. 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 |
| 2270. 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 |
| 2272. 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 |
| 2274. 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 |
| 2276. 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 |
| 2278. 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 |
| 2280. 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 |
| 2282. 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 |
| 2284. 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 |
| 2286. 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 |
| 2288. 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 |
| 2290. 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 |
| 2292. 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 |
| 2294. 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 namevalueSet. |
| 2296. 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 namevalueSetVersion. |
| 2298. 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 |
| 2300. 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 |
| 2302. 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:typeattribute. |
| Label | Translation |
| 2304. 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 |
| 2306. 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 |
| 2308. 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 |
| 2310. 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()) |
| 2312. 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 |
| 2314. 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 |
| 2316. 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 |
| 2318. 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 |
| 2320. 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 |
| 2322. 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 |
| 2324. 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 |
| 2326. 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()) |
| 2328. 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 |
| 2330. 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 |
| 2332. 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()) |
| 2334. 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 |
| 2336. 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 |
| 2338. 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 |
| 2340. 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 |
| 2342. 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 |
| 2344. 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 |
| 2346. 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 |
| 2348. 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 |
| 2350. ClinicalDocument.componentOf.encompassingEncounter.id | |
| Comments | This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2352. ClinicalDocument.componentOf.encompassingEncounter.code | |
| Comments | This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Act Encounter Codes (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2354. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime | |
| Comments | This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval) |
| 2356. 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 nameadmissionReferralSourceCode. |
| 2358. 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 |
| 2360. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty | |
| Definition | The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state. |
| Comments | This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 2362. 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 |
| 2364. 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 |
| 2366. 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()) |
| 2368. 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 |
| 2370. 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 |
| 2372. 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 |
| 2374. 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 |
| 2376. 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 |
| 2378. 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 |
| 2380. 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 |
| 2382. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity | |
| Comments | The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity |
| Invariants | 1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (assignedPerson.exists() or representedOrganization.exists()) |
| 2384. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant |
| 2386. ClinicalDocument.componentOf.encompassingEncounter.location | |
| Definition | The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class). The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow. When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
| 2388. 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 |
| 2390. 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 |
| 2392. 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()) |
| 2394. 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 |
| 2396. 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 |
| 2398. 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 |
| 2400. 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 |
| 2402. 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 |
| 2404. 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 |
| 2406. 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 |
| 2408. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility |
| 2410. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2412. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 2414. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 2416. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2418. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 2420. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 2422. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 2424. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 2426. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2428. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RoleClassServiceDeliveryLocation (required to http://terminology.hl7.org/ValueSet/v3-RoleClassServiceDeliveryLocation) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | SDLOC |
| 2430. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2432. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy. |
| 2434. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.code | |
| Control | 0..1 |
| Binding | For example codes, see ServiceDeliveryLocationRoleType (example to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 2436. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Place |
| 2438. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2440. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 2442. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists()) |
| 2444. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 2446. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 2448. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 2450. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 2452. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 2454. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 2456. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.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 |
| 2458. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.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 |
| 2460. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.name | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
| 2462. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.location.addr | |
| Short | 𝗨𝗦𝗖𝗗𝗜: Facility Address |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 2464. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility.serviceProviderOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 2466. ClinicalDocument.component | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Component |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#5.0.0-ballot based on FHIR 5.0.0. Generated 2025-12-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change