Clinical Document Architecture
2.0.0-sd-ballot - ballot
Clinical Document Architecture
2.0.0-sd-ballot - ballot
Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Reference | Version: 2.0.0-sd-ballot | |||
| Active as of 2024-03-04 | Computable Name: Reference | |||
CDA entries can reference external objects such as external images and prior reports. These external objects are not part of the authenticated document content. They contain sufficient attributes to enable an explicit reference rather than duplicating the entire referenced object. The CDA entry that wraps the external reference can be used to encode the specific portions of the external reference that are addressed in the narrative block.
Each object allows for an identifier and a code, and contains the RIM Act.text attribute, which can be used to store the URL and MIME type of the object. External objects always have a fixed moodCode of “EVN”.
The reference class contains the attribute reference.seperatableInd, which indicates whether or not the source is intended to be interpreted independently of the target. The indicator cannot prevent an individual or application from separating the source and target, but indicates the author’s desire and willingness to attest to the content of the source if separated from the target. Typically, where seperatableInd is “false”, the exchanged package should include the target of the reference so that the recipient can render it.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Reference | C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference |
  @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
 seperatableInd | 0..1 | BL | ||
  (Choice of one) | 1..1 | |||
  externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
 externalDocument | 0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.typeCode | required | XActRelationshipExternalReferencehttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
| Id | Grade | Path(s) | Details | Requirements |
| reference-external | error | Reference | Must contain one (and only one) external reference : (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Reference | C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd | 0..1 | BL | ||
| (Choice of one) | 1..1 | |||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.typeCode | required | XActRelationshipExternalReferencehttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
| Id | Grade | Path(s) | Details | Requirements |
| reference-external | error | Reference | Must contain one (and only one) external reference : (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Reference | C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
 typeId | 0..1 | II | ||
 @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
 @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd | 0..1 | BL | ||
| (Choice of one) | 1..1 | |||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Reference.typeCode | required | XActRelationshipExternalReferencehttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
| Id | Grade | Path(s) | Details | Requirements |
| reference-external | error | Reference | Must contain one (and only one) external reference : (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 |
This structure is derived from InfrastructureRoot
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Reference | C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd | 0..1 | BL | ||
| (Choice of one) | 1..1 | |||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.typeCode | required | XActRelationshipExternalReferencehttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
| Id | Grade | Path(s) | Details | Requirements |
| reference-external | error | Reference | Must contain one (and only one) external reference : (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Reference | C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd | 0..1 | BL | ||
| (Choice of one) | 1..1 | |||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.typeCode | required | XActRelationshipExternalReferencehttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
| Id | Grade | Path(s) | Details | Requirements |
| reference-external | error | Reference | Must contain one (and only one) external reference : (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Reference | C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) reference-external: Must contain one (and only one) external reference |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipExternalReference (required) | |
| seperatableInd | 0..1 | BL | ||
| (Choice of one) | 1..1 | |||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Reference.typeCode | required | XActRelationshipExternalReferencehttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
| Id | Grade | Path(s) | Details | Requirements |
| reference-external | error | Reference | Must contain one (and only one) external reference : (externalAct | externalObservation | externalProcedure | externalDocument).count() = 1 |
This structure is derived from InfrastructureRoot
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.0-sd-ballot based on FHIR 5.0.0. Generated 2024-03-04
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change