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 ResultOrganizer 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 (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7121). |
| 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:4537-7122). |
| 6. Organizer.templateId | |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-7126) such that it |
| 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:templateId1 | |
| Slice Name | templateId1 |
| Short | templateId |
| Control | 1..1 |
| 10. Organizer.templateId:templateId1.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.1" (CONF:4537-9134). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.1 |
| 12. Organizer.templateId:templateId1.extension | |
| Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32588). |
| Control | 1..? |
| Pattern Value | 2023-05-01 |
| 14. Organizer.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-7127). |
| Control | 1..? |
| 16. Organizer.code | |
| Comments | SHALL contain exactly one [1..1] code (CONF:4537-7128). |
| Control | 1..? |
| Invariants | 4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). () 4537-19219: Laboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219). () |
| 18. Organizer.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-7123). |
| 20. Organizer.statusCode.code | |
| Comments | This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Result Status urn:oid:2.16.840.1.113883.11.20.9.39 STATIC (CONF:4537-14848). |
| Control | 1..? |
| Binding | The codes SHALL be taken from Result Status |
| 22. Organizer.effectiveTime | |
| Short | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. |
| Comments | MAY contain zero or one [0..1] effectiveTime (CONF:4537-31865). |
| 24. Organizer.effectiveTime.low | |
| Comments | The effectiveTime, if present, SHALL contain exactly one [1..1] low (CONF:4537-32488). |
| Control | 1..? |
| 26. Organizer.effectiveTime.high | |
| Comments | The effectiveTime, if present, SHALL contain exactly one [1..1] high (CONF:4537-32489). |
| Control | 1..? |
| 28. Organizer.specimen | |
| Comments | MAY contain zero or more [0..*] specimen (CONF:4537-32615). |
| 30. Organizer.specimen.specimenRole | |
| Comments | The specimen, if present, SHALL contain exactly one [1..1] specimenRole (CONF:4537-32616). |
| 32. Organizer.specimen.specimenRole.specimenPlayingEntity | |
| Comments | This specimenRole SHALL contain exactly one [1..1] specimenPlayingEntity (CONF:4537-32617). |
| Control | 1..? |
| 34. Organizer.specimen.specimenRole.specimenPlayingEntity.code | |
| Comments | This specimenPlayingEntity SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Specimen type urn:oid:2.16.840.1.113762.1.4.1099.54 DYNAMIC (CONF:4537-32618). |
| Control | 1..? |
| Binding | The codes SHOULD be taken from VSAC 2.16.840.1.113762.1.4.1099.54 |
| 36. Organizer.author | |
| Comments | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4537-31149). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| 38. Organizer.component | |
| Comments | SHALL contain at least one [1..*] component (CONF:4537-7124) such that it |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Organizer.component. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 40. Organizer.component:component1 | |
| Slice Name | component1 |
| Short | component |
| Control | 1..* |
| 42. Organizer.component:component1.observation | |
| Comments | SHALL contain exactly one [1..1] Result Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.2:2015-08-01) (CONF:4537-14850). |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Result 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 (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7121). |
| 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. |
| 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:4537-7122). |
| 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-7126) such that it |
| 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:templateId1 | |
| Slice Name | templateId1 |
| 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 |
| Short | templateId |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 10. Organizer.templateId:templateId1.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.1" (CONF:4537-9134). |
| 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.1 |
| 12. Organizer.templateId:templateId1.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32588). |
| 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 | 2023-05-01 |
| 14. Organizer.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-7127). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 16. Organizer.code | |
| Comments | SHALL contain exactly one [1..1] code (CONF:4537-7128). |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| Invariants | 4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). () 4537-19219: Laboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219). () |
| 18. Organizer.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-7123). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 20. 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, which SHALL be selected from ValueSet Result Status urn:oid:2.16.840.1.113883.11.20.9.39 STATIC (CONF:4537-14848). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Result Status |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element 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 |
| 22. 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 |
| 24. 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 |
| 26. 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 |
| 28. 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 |
| 30. 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 |
| 32. 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 |
| 34. 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 |
| 36. Organizer.effectiveTime | |
| Short | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. |
| Comments | MAY contain zero or one [0..1] effectiveTime (CONF:4537-31865). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 38. Organizer.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Comments | The effectiveTime, if present, SHALL contain exactly one [1..1] low (CONF:4537-32488). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| 40. Organizer.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Comments | The effectiveTime, if present, SHALL contain exactly one [1..1] high (CONF:4537-32489). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| 42. Organizer.specimen | |
| Comments | MAY contain zero or more [0..*] specimen (CONF:4537-32615). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 44. Organizer.specimen.specimenRole | |
| Comments | The specimen, if present, SHALL contain exactly one [1..1] specimenRole (CONF:4537-32616). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SpecimenRole |
| 46. Organizer.specimen.specimenRole.specimenPlayingEntity | |
| Comments | This specimenRole SHALL contain exactly one [1..1] specimenPlayingEntity (CONF:4537-32617). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
| 48. Organizer.specimen.specimenRole.specimenPlayingEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassRoot |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive 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 | ENT |
| 50. Organizer.specimen.specimenRole.specimenPlayingEntity.code | |
| Comments | This specimenPlayingEntity SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Specimen type urn:oid:2.16.840.1.113762.1.4.1099.54 DYNAMIC (CONF:4537-32618). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from VSAC 2.16.840.1.113762.1.4.1099.54 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 52. Organizer.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4537-31149). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Organizer.component | |
| Comments | SHALL contain at least one [1..*] component (CONF:4537-7124) such that it |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent |
| Slicing | This element introduces a set of slices on Organizer.component. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 56. Organizer.component:component1 | |
| Slice Name | component1 |
| Short | component |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent |
| 58. Organizer.component:component1.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Result Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.2:2015-08-01) (CONF:4537-14850). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Result 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 (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-7121). |
| 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. |
| 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:4537-7122). |
| 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-7126) such that it |
| 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:templateId1 | |
| Slice Name | templateId1 |
| 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 |
| Short | templateId |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 14. Organizer.templateId:templateId1.nullFlavor | |
| Definition | If a value is an exceptional 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:templateId1.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:templateId1.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:templateId1.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.1" (CONF:4537-9134). |
| 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.1 |
| 22. Organizer.templateId:templateId1.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32588). |
| 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 | 2023-05-01 |
| 24. Organizer.id | |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-7127). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 26. Organizer.code | |
| Comments | SHALL contain exactly one [1..1] code (CONF:4537-7128). |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| Invariants | 4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). () 4537-19219: Laboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219). () |
| 28. Organizer.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-7123). |
| 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, which SHALL be selected from ValueSet Result Status urn:oid:2.16.840.1.113883.11.20.9.39 STATIC (CONF:4537-14848). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Result Status |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element 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 |
| 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 | |
| Short | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. |
| Comments | MAY contain zero or one [0..1] effectiveTime (CONF:4537-31865). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 54. Organizer.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 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 |
| 56. Organizer.effectiveTime.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | string(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. |
| 58. Organizer.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 SetOperator |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive 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 |
| 60. Organizer.effectiveTime.low | |
| Definition | This is the low limit of the interval. |
| Comments | The effectiveTime, if present, SHALL contain exactly one [1..1] low (CONF:4537-32488). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| 62. Organizer.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 |
| 64. Organizer.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 |
| 66. Organizer.effectiveTime.high | |
| Definition | This is the high limit of the interval. |
| Comments | The effectiveTime, if present, SHALL contain exactly one [1..1] high (CONF:4537-32489). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| 68. Organizer.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 70. Organizer.specimen | |
| Comments | MAY contain zero or more [0..*] specimen (CONF:4537-32615). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 72. Organizer.specimen.nullFlavor | |
| Definition | If a value is an exceptional 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 |
| 74. Organizer.specimen.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 |
| 76. Organizer.specimen.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 |
| 78. Organizer.specimen.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 |
| 80. Organizer.specimen.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | SPC |
| 82. Organizer.specimen.specimenRole | |
| Comments | The specimen, if present, SHALL contain exactly one [1..1] specimenRole (CONF:4537-32616). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SpecimenRole |
| 84. Organizer.specimen.specimenRole.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RoleClassSpecimen |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | SPEC |
| 86. Organizer.specimen.specimenRole.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 |
| 88. Organizer.specimen.specimenRole.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 90. Organizer.specimen.specimenRole.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. |
| 92. Organizer.specimen.specimenRole.specimenPlayingEntity | |
| Comments | This specimenRole SHALL contain exactly one [1..1] specimenPlayingEntity (CONF:4537-32617). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
| 94. Organizer.specimen.specimenRole.specimenPlayingEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassRoot |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive 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 | ENT |
| 96. Organizer.specimen.specimenRole.specimenPlayingEntity.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 |
| 98. Organizer.specimen.specimenRole.specimenPlayingEntity.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 |
| 100. Organizer.specimen.specimenRole.specimenPlayingEntity.code | |
| Comments | This specimenPlayingEntity SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Specimen type urn:oid:2.16.840.1.113762.1.4.1099.54 DYNAMIC (CONF:4537-32618). |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from VSAC 2.16.840.1.113762.1.4.1099.54 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 102. Organizer.specimen.specimenRole.specimenPlayingEntity.quantity | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 104. Organizer.specimen.specimenRole.specimenPlayingEntity.name | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| 106. Organizer.specimen.specimenRole.specimenPlayingEntity.sdtcBirthTime | |
| 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 namebirthTime. |
| 108. Organizer.specimen.specimenRole.specimenPlayingEntity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 110. Organizer.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 112. Organizer.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4537-31149). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 114. Organizer.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 116. Organizer.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 118. Organizer.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 120. Organizer.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 122. Organizer.component | |
| Comments | SHALL contain at least one [1..*] component (CONF:4537-7124) such that it |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent |
| Slicing | This element introduces a set of slices on Organizer.component. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 124. Organizer.component:component1 | |
| Slice Name | component1 |
| Short | component |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent |
| 126. Organizer.component:component1.nullFlavor | |
| Definition | If a value is an exceptional 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 |
| 128. Organizer.component:component1.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. Organizer.component:component1.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 |
| 132. Organizer.component:component1.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 |
| 134. Organizer.component:component1.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 |
| 136. Organizer.component:component1.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 |
| 138. Organizer.component:component1.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 140. Organizer.component:component1.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. |
| 142. Organizer.component:component1.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 144. Organizer.component:component1.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 146. Organizer.component:component1.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 148. Organizer.component:component1.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Comments | SHALL contain exactly one [1..1] Result Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.2:2015-08-01) (CONF:4537-14850). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Result Observation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 150. Organizer.component:component1.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 152. Organizer.component:component1.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 154. Organizer.component:component1.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 156. Organizer.component:component1.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 158. Organizer.component:component1.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 160. Organizer.component:component1.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