Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions
Active as of 2023-10-03 |
Definitions for the Reference logical model.
Guidance on how to interpret the contents of this table can be found here
0. Reference | |
Control | 1..* |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | reference-external: Must contain one (and only one) external reference ((externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 ) |
2. Reference.typeCode | |
Definition | Element Act.typeCode |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipExternalReference |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive 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. Reference.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
6. Reference.externalAct | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalAct |
8. Reference.externalObservation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation |
10. Reference.externalProcedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure |
12. Reference.externalDocument | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument |
Guidance on how to interpret the contents of this table can be found here
0. Reference | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 10..* |
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())) reference-external: Must contain one (and only one) external reference ( (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 ) |
2. Reference.typeCode | |
Definition | Element Act.typeCode |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipExternalReference |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive 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. Reference.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
6. Reference.externalAct | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalAct |
8. Reference.externalObservation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation |
10. Reference.externalProcedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure |
12. Reference.externalDocument | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument |
Guidance on how to interpret the contents of this table can be found here
0. Reference | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 1..* |
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()) )reference-external: Must contain one (and only one) external reference ( (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 ) |
2. Reference.nullFlavor | |
Definition | If a value is an exceptional 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 |
4. Reference.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 |
6. Reference.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 |
8. Reference.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 |
10. Reference.typeCode | |
Definition | Element Act.typeCode |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipExternalReference |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
12. Reference.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
14. Reference.externalAct | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalAct |
16. Reference.externalObservation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation |
18. Reference.externalProcedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure |
20. Reference.externalDocument | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument |