Consolidated CDA Release 2.2
2.2 - CI Build

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/cda-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: Advance Directives Section (entries required)

Defining URL:http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.2.21.1
Version:2.2
Name:AdvanceDirectivesSectionentriesrequired
Title:Advance Directives Section (entries required)
Status:Active as of 11/24/21, 5:43 PM
Definition:

This section contains data defining the patients advance directives and any reference to supporting documentation, including living wills, healthcare proxies, and CPR and resuscitation status. If the referenced documents are available, they can be included in the exchange package.

The most recent directives are required, if known, and should be listed in as much detail as possible.

This section differentiates between "advance directives" and "advance directive documents". The former is the directions to be followed whereas the latter refers to a legal document containing those directions.

Publisher:Health Level Seven
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.2.21.1

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AdvanceDirectivesSectionEntriesOptional

Summary

Mandatory: 9 elements

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the values of value:root, value:extension

This structure is derived from AdvanceDirectivesSectionEntriesOptional

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1AdvanceDirectivesSectionEntriesOptional
... nullFlavor 0..1codeRequired Pattern: NI
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:secondary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.21.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 1..1CE
.... code 1..1stringRequired Pattern: 42348-3
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1xhtml
... entry I1..*Element1198-32881: This entry **SHALL** contain *EITHER* an Advance Directive Observation (V2) *OR* an Advance Directive Organizer (CONF:1198-32881).

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1AdvanceDirectivesSectionEntriesOptional
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
Required Pattern: NI
... classCode 1..1codeBinding: http://terminology.hl7.org/ValueSet/v3-ActClassOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.21
..... extension 1..1stringRequired Pattern: 2015-08-01
.... templateId:secondary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.21.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 42348-3
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1ED
... text S1..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for entry I1..*ElementSlice: Unordered, Open by exists:*
1198-32881: This entry **SHALL** contain *EITHER* an Advance Directive Observation (V2) *OR* an Advance Directive Organizer (CONF:1198-32881).
.... entry:observation I0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... observation 1..1AdvanceDirectiveObservation
.... entry:organizer I0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... organizer 1..1AdvanceDirectiveOrganizer
... component 0..*Element
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

This structure is derived from AdvanceDirectivesSectionEntriesOptional

Summary

Mandatory: 9 elements

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from AdvanceDirectivesSectionEntriesOptional

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1AdvanceDirectivesSectionEntriesOptional
... nullFlavor 0..1codeRequired Pattern: NI
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:secondary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.21.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 1..1CE
.... code 1..1stringRequired Pattern: 42348-3
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1xhtml
... entry I1..*Element1198-32881: This entry **SHALL** contain *EITHER* an Advance Directive Observation (V2) *OR* an Advance Directive Organizer (CONF:1198-32881).

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1AdvanceDirectivesSectionEntriesOptional
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
Required Pattern: NI
... classCode 1..1codeBinding: http://terminology.hl7.org/ValueSet/v3-ActClassOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.21
..... extension 1..1stringRequired Pattern: 2015-08-01
.... templateId:secondary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.21.1
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 42348-3
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1ED
... text S1..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for entry I1..*ElementSlice: Unordered, Open by exists:*
1198-32881: This entry **SHALL** contain *EITHER* an Advance Directive Observation (V2) *OR* an Advance Directive Organizer (CONF:1198-32881).
.... entry:observation I0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... observation 1..1AdvanceDirectiveObservation
.... entry:organizer I0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... organizer 1..1AdvanceDirectiveOrganizer
... component 0..*Element
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredPattern: NI
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.templateId:primary.nullFlavorrequiredNullFlavor
Section.templateId:secondary.nullFlavorrequiredNullFlavor
Section.codeextensibleDocumentSectionType
Section.code.nullFlavorrequiredNullFlavor
Section.languageCoderequiredHumanLanguage
Section.subject.typeCoderequiredFixed Value: SBJ
Section.subject.contextControlCoderequiredFixed Value: OP
Section.subject.awarenessCodeextensibleTargetAwareness
Section.informant.typeCoderequiredFixed Value: INF
Section.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdPathDetailsRequirements
only-one-statementSection.entrySHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
1198-32881Section.entryThis entry **SHALL** contain *EITHER* an Advance Directive Observation (V2) *OR* an Advance Directive Organizer (CONF:1198-32881).
:
only-one-statementSection.entry:observationSHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
only-one-statementSection.entry:organizerSHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1