Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectivesSection | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: AdvanceDirectivesSection | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2022-02-14 | ||||
This section contains information describing the patient’s advance directives. The description includes the kind of advance directive source documents and the type of advance directive content included in each kind of advance directive source document. The section includes information about who verified the content available in each advance directive source document, if applicable. It also includes information about who was the acting healthcare agent, if someone was acting on behalf of the patient during the encounter or during certain periods of time during the provision of care covered by the document. It provides references to the supporting documentation, including all kinds of advance directive source documents.
Treatment Preferences, Care Experience Preferences and Personal Health Goals considered relevant by the organization rendering care services to the patient’s care during the encompassing encounter or considered relevant to the patient’s care plan SHALL be included in the Advance Directives Section as documented by the patient or consented by the patient or the patient’s healthcare agent.
If a person has appointed healthcare agent(s), the Advance Directive Section SHALL include the current healthcare agent(s) information. and a reference to the external document which contains the healthcare agent appointment decisions. If a person has documented treatment preferences under certain health scenarios, the Advance Directive Section SHALL include information about who has reviewed and verified that documentation, and a reference to the external document which was reviewed.
This section differentiates between an “advance care plan document” and an “advance care plan order.” It also distinguishes an advance directive that is a consent. Information in this section includes information about the person’s current/relevant goals and preferences, advance directive orders, or advance directive consents.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Section
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-adv-directive-organizer: SHALL contain at least one Advance Directive Organizer |
 @nullFlavor | 0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:section | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.21.1 | |
  @extension | 1..1 | st | Required Pattern: 2022-02-14 | |
| code | 1..1 | CE | Advance Directives | |
| @code | 1..1 | cs | Required Pattern: 42348-3 | |
 @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title | 1..1 | ST | ||
| text | 1..1 | xhtml | ||
 Slices for entry | 0..* | Entry | If section/@nullFlavor is not present SHALL contain an Advance Directive Observation OR an Advance Directive Organizer (NEW): Slice: Unordered, Open by profile:observation, profile:organizer | |
 entry:observation | 0..* | Entry | ||
  observation | 1..1 | AdvanceDirectiveObservation | Base for all types and resources | |
| entry:organizer | 0..* | Entry | ||
| organizer | 1..1 | AdvanceDirectiveOrganizer | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| shall-adv-directive-organizer | error | Section | SHALL contain at least one Advance Directive Organizer : nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-adv-directive-organizer: SHALL contain at least one Advance Directive Organizer |
 @nullFlavor | 0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI Binding: CDANullFlavor (required) | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.21.1 | |
| @extension | 1..1 | st | Required Pattern: 2022-02-14 | |
| code | 1..1 | CE | Advance Directives Binding: DocumentSectionType (example) | |
| @code | 1..1 | cs | Required Pattern: 42348-3 | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title | 1..1 | ST | ||
| text | 1..1 | xhtml | ||
| Slices for entry | 0..* | Entry | If section/@nullFlavor is not present SHALL contain an Advance Directive Observation OR an Advance Directive Organizer (NEW): Slice: Unordered, Open by profile:observation, profile:organizer | |
| entry:observation | 0..* | Entry | ||
| observation | C | 1..1 | AdvanceDirectiveObservation | Base for all types and resources |
| entry:organizer | 0..* | Entry | ||
| organizer | C | 1..1 | AdvanceDirectiveOrganizer | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Section.nullFlavor | required | CDANullFlavor |
| Section.code | example | DocumentSectionType |
| Id | Grade | Path(s) | Details | Requirements |
| shall-adv-directive-organizer | error | Section | SHALL contain at least one Advance Directive Organizer : nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')) | |
| should-author | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain author : author.exists() | |
| should-informant | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain informant : informant.exists() | |
| should-participant | warning | Section.entry:organizer.organizer | SHOULD contain participant : participant.exists() | |
| should-sdtctext-ref-value | warning | Section.entry:organizer.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Section.entry:observation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() |
| Path | Conformance | ValueSet / Code |
| Section.nullFlavor | required | CDANullFlavor |
| Section.typeId.nullFlavor | required | CDANullFlavor |
| Section.templateId:section.nullFlavor | required | CDANullFlavor |
| Section.classCode | required | Fixed Value: DOCSECT |
| Section.moodCode | required | Fixed Value: EVN |
| Section.code | example | DocumentSectionType |
| Section.code.nullFlavor | required | CDANullFlavor |
| Section.languageCode | required | AllLanguages |
| Section.entry:observation.nullFlavor | required | CDANullFlavor |
| Section.entry:observation.typeId.nullFlavor | required | CDANullFlavor |
| Section.entry:observation.typeCode | required | XActRelationshipEntry |
| Section.entry:organizer.nullFlavor | required | CDANullFlavor |
| Section.entry:organizer.typeId.nullFlavor | required | CDANullFlavor |
| Section.entry:organizer.typeCode | required | XActRelationshipEntry |
| Section.component.nullFlavor | required | CDANullFlavor |
| Section.component.typeId.nullFlavor | required | CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| shall-adv-directive-organizer | error | Section | SHALL contain at least one Advance Directive Organizer : nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')) | |
| should-author | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain author : author.exists() | |
| should-informant | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain informant : informant.exists() | |
| should-participant | warning | Section.entry:organizer.organizer | SHOULD contain participant : participant.exists() | |
| should-sdtctext-ref-value | warning | Section.entry:organizer.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Section.entry:observation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Section
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-adv-directive-organizer: SHALL contain at least one Advance Directive Organizer |
| @nullFlavor | 0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.21.1 | |
| @extension | 1..1 | st | Required Pattern: 2022-02-14 | |
| code | 1..1 | CE | Advance Directives | |
| @code | 1..1 | cs | Required Pattern: 42348-3 | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title | 1..1 | ST | ||
| text | 1..1 | xhtml | ||
| Slices for entry | 0..* | Entry | If section/@nullFlavor is not present SHALL contain an Advance Directive Observation OR an Advance Directive Organizer (NEW): Slice: Unordered, Open by profile:observation, profile:organizer | |
| entry:observation | 0..* | Entry | ||
| observation | 1..1 | AdvanceDirectiveObservation | Base for all types and resources | |
| entry:organizer | 0..* | Entry | ||
| organizer | 1..1 | AdvanceDirectiveOrganizer | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| shall-adv-directive-organizer | error | Section | SHALL contain at least one Advance Directive Organizer : nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) shall-adv-directive-organizer: SHALL contain at least one Advance Directive Organizer |
| @nullFlavor | 0..1 | cs | If a required section contains no information, the @nullFlavor MAY be set to NI Binding: CDANullFlavor (required) | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.21.1 | |
| @extension | 1..1 | st | Required Pattern: 2022-02-14 | |
| code | 1..1 | CE | Advance Directives Binding: DocumentSectionType (example) | |
| @code | 1..1 | cs | Required Pattern: 42348-3 | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| title | 1..1 | ST | ||
| text | 1..1 | xhtml | ||
| Slices for entry | 0..* | Entry | If section/@nullFlavor is not present SHALL contain an Advance Directive Observation OR an Advance Directive Organizer (NEW): Slice: Unordered, Open by profile:observation, profile:organizer | |
| entry:observation | 0..* | Entry | ||
| observation | C | 1..1 | AdvanceDirectiveObservation | Base for all types and resources |
| entry:organizer | 0..* | Entry | ||
| organizer | C | 1..1 | AdvanceDirectiveOrganizer | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Section.nullFlavor | required | CDANullFlavor |
| Section.code | example | DocumentSectionType |
| Id | Grade | Path(s) | Details | Requirements |
| shall-adv-directive-organizer | error | Section | SHALL contain at least one Advance Directive Organizer : nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')) | |
| should-author | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain author : author.exists() | |
| should-informant | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain informant : informant.exists() | |
| should-participant | warning | Section.entry:organizer.organizer | SHOULD contain participant : participant.exists() | |
| should-sdtctext-ref-value | warning | Section.entry:organizer.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Section.entry:observation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Section.nullFlavor | required | CDANullFlavor |
| Section.typeId.nullFlavor | required | CDANullFlavor |
| Section.templateId:section.nullFlavor | required | CDANullFlavor |
| Section.classCode | required | Fixed Value: DOCSECT |
| Section.moodCode | required | Fixed Value: EVN |
| Section.code | example | DocumentSectionType |
| Section.code.nullFlavor | required | CDANullFlavor |
| Section.languageCode | required | AllLanguages |
| Section.entry:observation.nullFlavor | required | CDANullFlavor |
| Section.entry:observation.typeId.nullFlavor | required | CDANullFlavor |
| Section.entry:observation.typeCode | required | XActRelationshipEntry |
| Section.entry:organizer.nullFlavor | required | CDANullFlavor |
| Section.entry:organizer.typeId.nullFlavor | required | CDANullFlavor |
| Section.entry:organizer.typeCode | required | XActRelationshipEntry |
| Section.component.nullFlavor | required | CDANullFlavor |
| Section.component.typeId.nullFlavor | required | CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| shall-adv-directive-organizer | error | Section | SHALL contain at least one Advance Directive Organizer : nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')) | |
| should-author | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain author : author.exists() | |
| should-informant | warning | Section.entry:observation.observation, Section.entry:organizer.organizer | SHOULD contain informant : informant.exists() | |
| should-participant | warning | Section.entry:organizer.organizer | SHOULD contain participant : participant.exists() | |
| should-sdtctext-ref-value | warning | Section.entry:organizer.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Section.entry:observation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change
