Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.6.2.3 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. RelatedSubject | |
| 2. RelatedSubject.templateId | |
| 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:
|
| 3. RelatedSubject.templateId:primary | |
| SliceName | primary |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:81-9189) such that it |
| 4. RelatedSubject.templateId:primary.root | |
| Control | 1..1 |
| 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 |
| 5. RelatedSubject.code | |
| Control | 10..1 |
| Requirements | SHALL contain exactly one [1..1] code (CONF:81-9190). |
| 6. RelatedSubject.code.code | |
| Control | 1..1 |
| Requirements | This code SHALL contain exactly one [1..1] @code="121026" (CONF:81-26455). |
| Pattern Value | 121026 |
| 7. RelatedSubject.code.codeSystem | |
| Control | 1..1 |
| 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 |
| 8. RelatedSubject.subject | |
| Control | 10..1 |
| Requirements | SHALL contain exactly one [1..1] subject (CONF:81-9191). |
| 9. RelatedSubject.subject.name | |
| Control | 1..1 |
| Requirements | This subject SHALL contain exactly one [1..1] name (CONF:81-15347). |
Guidance on how to interpret the contents of this table can be found here.
| 1. RelatedSubject | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. RelatedSubject.classCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| 6. 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). |
| 7. 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This code SHALL contain exactly one [1..1] @code="121026" (CONF:81-26455). |
| Pattern Value | 121026 |
| 8. RelatedSubject.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| 9. 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 |
| 10. RelatedSubject.subject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubjectPerson |
| Requirements | SHALL contain exactly one [1..1] subject (CONF:81-9191). |
| 11. RelatedSubject.subject.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 12. RelatedSubject.subject.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 13. 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). |
Guidance on how to interpret the contents of this table can be found here.
| 1. RelatedSubject | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| 2. RelatedSubject.classCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 15. RelatedSubject.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion. |
| 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 |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 26. RelatedSubject.subject.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name desc. |
| 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 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedInd. |
| 33. RelatedSubject.subject.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedTime. |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 generated with FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change