Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Active as of 2022-05-13 |
Definitions for the 2.16.840.1.113883.10.20.6.2.3 resource profile.
1. RelatedSubject | |
Control | 1..1 |
2. RelatedSubject.classCode | |
Control | 1..1 |
Type | code |
Default Value | PRS |
3. RelatedSubject.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Slicing | This element introduces a set of slices on RelatedSubject.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. RelatedSubject.templateId:primary | |
SliceName | primary |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Requirements | SHALL contain exactly one [1..1] templateId (CONF:81-9189) such that it |
5. RelatedSubject.templateId:primary.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
6. RelatedSubject.templateId:primary.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string |
7. RelatedSubject.templateId:primary.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean |
8. RelatedSubject.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.6.2.3" (CONF:81-10535). |
Pattern Value | 2.16.840.1.113883.10.20.6.2.3 |
9. RelatedSubject.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string |
10. RelatedSubject.code | |
Control | 1..1 |
Binding | The codes SHALL be taken from PersonalRelationshipRoleType; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
Requirements | SHALL contain exactly one [1..1] code (CONF:81-9190). |
11. RelatedSubject.code.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
12. RelatedSubject.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 | string |
Requirements | This code SHALL contain exactly one [1..1] @code="121026" (CONF:81-26455). |
Pattern Value | 121026 |
13. RelatedSubject.code.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 1..1 |
Type | string |
Requirements | This code SHALL contain exactly one [1..1] @codeSystem="1.2.840.10008.2.16.4" (CodeSystem: DCM urn:oid:1.2.840.10008.2.16.4) (CONF:81-26476). |
Pattern Value | 1.2.840.10008.2.16.4 |
14. RelatedSubject.code.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..1 |
Type | string |
15. RelatedSubject.code.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..1 |
Type | string |
16. RelatedSubject.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 |
17. RelatedSubject.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 |
18. RelatedSubject.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 |
19. RelatedSubject.code.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
20. RelatedSubject.code.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
21. RelatedSubject.code.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
22. RelatedSubject.addr | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
23. RelatedSubject.telecom | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
24. RelatedSubject.subject | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/SubjectPerson |
Requirements | SHALL contain exactly one [1..1] subject (CONF:81-9191). |
25. RelatedSubject.subject.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassLivingSubject |
Type | code |
Default Value | PSN |
Fixed Value | PSN |
26. RelatedSubject.subject.determinerCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityDeterminer |
Type | code |
Default Value | INSTANCE |
Fixed Value | INSTANCE |
27. RelatedSubject.subject.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
28. RelatedSubject.subject.name | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/EN |
Requirements | This subject SHALL contain exactly one [1..1] name (CONF:81-15347). |
29. RelatedSubject.subject.sdtcDesc | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
30. RelatedSubject.subject.administrativeGenderCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from AdministrativeGender; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
31. RelatedSubject.subject.birthTime | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
32. RelatedSubject.subject.sdtcDeceasedInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
33. RelatedSubject.subject.sdtcDeceasedTime | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TS |