Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-29 |
Definitions for the FamilyHistoryOrganizer logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. Organizer | |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Organizer.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="CLUSTER" Cluster (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8600). |
| Fixed Value | CLUSTER |
| 4. Organizer.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8601). |
| 6. Organizer.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Organizer.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 8. Organizer.templateId:primary | |
| Slice Name | primary |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-8604) such that it |
| Control | 1..1 |
| 10. Organizer.templateId:primary.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.45" (CONF:1198-10497). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.45 |
| 12. Organizer.templateId:primary.extension | |
| Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32606). |
| Control | 1..? |
| Pattern Value | 2015-08-01 |
| 14. Organizer.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1198-32485). |
| Control | 1..? |
| 16. Organizer.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1198-8602). |
| 18. Organizer.statusCode.code | |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19099). |
| Control | 1..? |
| Fixed Value | completed |
| 20. Organizer.subject | |
| Comments | SHALL contain exactly one [1..1] subject (CONF:1198-8609). |
| Control | 1..? |
| 22. Organizer.subject.relatedSubject | |
| Comments | This subject SHALL contain exactly one [1..1] relatedSubject (CONF:1198-15244). |
| 24. Organizer.subject.relatedSubject.classCode | |
| Comments | This relatedSubject SHALL contain exactly one [1..1] @classCode="PRS" Person (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1198-15245). |
| Fixed Value | PRS |
| 26. Organizer.subject.relatedSubject.code | |
| Comments | This relatedSubject SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Family Member Value urn:oid:2.16.840.1.113883.1.11.19579 DYNAMIC (CONF:1198-15246). |
| Control | 1..? |
| Binding | The codes SHOULD be taken from Family Member Value |
| 28. Organizer.subject.relatedSubject.subject | |
| Comments | This relatedSubject SHOULD contain zero or one [0..1] subject (CONF:1198-15248). |
| Invariants | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. 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 id element (CONF:1198-15249). () 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. 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 deceasedInd element (CONF:1198-15981). () 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. 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 deceasedTime element (CONF:1198-15982). () 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). () |
| 30. Organizer.subject.relatedSubject.subject.administrativeGenderCode | |
| Comments | The subject, if present, SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-15974). |
| Control | 1..? |
| Binding | The codes SHALL be taken from Administrative Gender (HL7 V3) |
| 32. Organizer.subject.relatedSubject.subject.birthTime | |
| Comments | The subject, if present, SHOULD contain zero or one [0..1] birthTime (CONF:1198-15976). |
| 34. Organizer.component | |
| Comments | SHALL contain at least one [1..*] component (CONF:1198-32428). |
| Control | 1..? |
| 36. Organizer.component.observation | |
| Comments | Such components SHALL contain exactly one [1..1] Family History Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.46:2015-08-01) (CONF:1198-32429). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Family History Observation) |
Guidance on how to interpret the contents of this table can be found here
| 0. Organizer | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. Organizer.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="CLUSTER" Cluster (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8600). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | CLUSTER |
| 4. Organizer.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8601). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive 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 | EVN |
| Fixed Value | EVN |
| 6. Organizer.templateId | |
| Definition | When valued in an instance, this attribute signals 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 Organizer.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 8. Organizer.templateId:primary | |
| Slice Name | 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-8604) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. Organizer.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. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.45" (CONF:1198-10497). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may 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.4.45 |
| 12. Organizer.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32606). |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may 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 | 2015-08-01 |
| 14. Organizer.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1198-32485). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 16. Organizer.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1198-8602). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 18. Organizer.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: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19099). |
| 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 |
| 20. Organizer.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 |
| 22. Organizer.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 |
| 24. Organizer.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 |
| 26. Organizer.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 |
| 28. Organizer.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 |
| 30. Organizer.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 |
| 32. Organizer.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 |
| 34. Organizer.subject | |
| Comments | SHALL contain exactly one [1..1] subject (CONF:1198-8609). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 36. Organizer.subject.relatedSubject | |
| Comments | This subject SHALL contain exactly one [1..1] relatedSubject (CONF:1198-15244). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedSubject |
| 38. Organizer.subject.relatedSubject.classCode | |
| Comments | This relatedSubject SHALL contain exactly one [1..1] @classCode="PRS" Person (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1198-15245). |
| 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. |
| Default Value | PRS |
| Fixed Value | PRS |
| 40. Organizer.subject.relatedSubject.code | |
| Comments | This relatedSubject SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Family Member Value urn:oid:2.16.840.1.113883.1.11.19579 DYNAMIC (CONF:1198-15246). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Family Member Value |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 42. Organizer.subject.relatedSubject.subject | |
| Comments | This relatedSubject SHOULD contain zero or one [0..1] subject (CONF:1198-15248). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubjectPerson |
| Invariants | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. 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 id element (CONF:1198-15249). () 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. 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 deceasedInd element (CONF:1198-15981). () 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. 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 deceasedTime element (CONF:1198-15982). () 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). () |
| 44. Organizer.subject.relatedSubject.subject.administrativeGenderCode | |
| Comments | The subject, if present, SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-15974). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Administrative Gender (HL7 V3) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 46. Organizer.subject.relatedSubject.subject.birthTime | |
| Comments | The subject, if present, SHOULD contain zero or one [0..1] birthTime (CONF:1198-15976). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 48. Organizer.component | |
| Comments | SHALL contain at least one [1..*] component (CONF:1198-32428). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent |
| 50. Organizer.component.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | Such components SHALL contain exactly one [1..1] Family History Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.46:2015-08-01) (CONF:1198-32429). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Family History Observation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
| 0. Organizer | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. Organizer.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="CLUSTER" Cluster (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8600). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClass |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | CLUSTER |
| 4. Organizer.moodCode | |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8601). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActMood |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive 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 | EVN |
| Fixed Value | EVN |
| 6. Organizer.realmCode | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 8. Organizer.typeId | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. Organizer.templateId | |
| Definition | When valued in an instance, this attribute signals 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 Organizer.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 12. Organizer.templateId:primary | |
| Slice Name | 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:1198-8604) such that it |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 14. Organizer.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(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 16. Organizer.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(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 18. Organizer.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(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 20. Organizer.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. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.45" (CONF:1198-10497). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may 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.4.45 |
| 22. Organizer.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32606). |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may 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 | 2015-08-01 |
| 24. Organizer.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:1198-32485). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 26. Organizer.code | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 28. Organizer.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:1198-8602). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 30. Organizer.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 NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 32. Organizer.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: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19099). |
| 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 |
| 34. Organizer.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 |
| 36. Organizer.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 |
| 38. Organizer.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 |
| 40. Organizer.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 |
| 42. Organizer.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. |
| 44. Organizer.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. |
| 46. Organizer.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 |
| 48. Organizer.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 |
| 50. Organizer.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 |
| 52. Organizer.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 54. Organizer.subject | |
| Comments | SHALL contain exactly one [1..1] subject (CONF:1198-8609). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 56. Organizer.subject.nullFlavor | |
| Definition | If a value is an exceptional 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(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 58. Organizer.subject.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 60. Organizer.subject.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 62. Organizer.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/cda/stds/core/StructureDefinition/II |
| 64. Organizer.subject.typeCode | |
| Definition | Element Act.typeCode |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationTargetSubject |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | SBJ |
| 66. Organizer.subject.contextControlCode | |
| Definition | Element Act.contextControlCode |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may 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 |
| 68. Organizer.subject.awarenessCode | |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from TargetAwareness |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 70. Organizer.subject.relatedSubject | |
| Comments | This subject SHALL contain exactly one [1..1] relatedSubject (CONF:1198-15244). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RelatedSubject |
| 72. Organizer.subject.relatedSubject.classCode | |
| Comments | This relatedSubject SHALL contain exactly one [1..1] @classCode="PRS" Person (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1198-15245). |
| 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. |
| Default Value | PRS |
| Fixed Value | PRS |
| 74. Organizer.subject.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/cda/stds/core/StructureDefinition/II |
| 76. Organizer.subject.relatedSubject.code | |
| Comments | This relatedSubject SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Family Member Value urn:oid:2.16.840.1.113883.1.11.19579 DYNAMIC (CONF:1198-15246). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Family Member Value |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 78. Organizer.subject.relatedSubject.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 80. Organizer.subject.relatedSubject.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 82. Organizer.subject.relatedSubject.subject | |
| Comments | This relatedSubject SHOULD contain zero or one [0..1] subject (CONF:1198-15248). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubjectPerson |
| Invariants | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. 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 id element (CONF:1198-15249). () 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. 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 deceasedInd element (CONF:1198-15981). () 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. 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 deceasedTime element (CONF:1198-15982). () 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). () |
| 84. Organizer.subject.relatedSubject.subject.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from 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 |
| 86. Organizer.subject.relatedSubject.subject.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from 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 |
| 88. Organizer.subject.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/cda/stds/core/StructureDefinition/II |
| 90. Organizer.subject.relatedSubject.subject.name | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| 92. Organizer.subject.relatedSubject.subject.sdtcDesc | |
| 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. |
| 94. Organizer.subject.relatedSubject.subject.administrativeGenderCode | |
| Comments | The subject, if present, SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-15974). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Administrative Gender (HL7 V3) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 96. Organizer.subject.relatedSubject.subject.birthTime | |
| Comments | The subject, if present, SHOULD contain zero or one [0..1] birthTime (CONF:1198-15976). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 98. Organizer.subject.relatedSubject.subject.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd. |
| 100. Organizer.subject.relatedSubject.subject.sdtcDeceasedTime | |
| 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. |
| 102. Organizer.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 104. Organizer.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 106. Organizer.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 108. Organizer.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 110. Organizer.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 112. Organizer.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 114. Organizer.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 116. Organizer.component | |
| Comments | SHALL contain at least one [1..*] component (CONF:1198-32428). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent |
| 118. Organizer.component.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 120. Organizer.component.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 122. Organizer.component.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 124. Organizer.component.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 126. Organizer.component.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from 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. |
| Default Value | COMP |
| 128. Organizer.component.contextConductionInd | |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | true |
| 130. Organizer.component.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 132. Organizer.component.priorityNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc. |
| 134. Organizer.component.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 136. Organizer.component.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 138. Organizer.component.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 140. Organizer.component.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | Such components SHALL contain exactly one [1..1] Family History Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.46:2015-08-01) (CONF:1198-32429). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Family History Observation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. Organizer.component.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 144. Organizer.component.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 146. Organizer.component.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 148. Organizer.component.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 150. Organizer.component.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 152. Organizer.component.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change