Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: AdvanceDirectiveExistenceObservation - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the AdvanceDirectiveExistenceObservation logical model.

Guidance on how to interpret the contents of this table can be found here

0. Observation
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
no-obs-if-existance-false: If value = 'false', then no Advance Directive Observation entries will be present. ((value.code = 'false') implies (entryRelationship.count() = 0))
2. Observation.templateId
Control1..?
SlicingThis element introduces a set of slices on Observation.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Observation.templateId:advance-directive-exist-obs
    Slice Nameadvance-directive-exist-obs
    Control1..1
    6. Observation.templateId:advance-directive-exist-obs.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.513
    8. Observation.templateId:advance-directive-exist-obs.extension
    Control1..?
    Pattern Value2025-05-01
    10. Observation.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC).

    Fixed ValueOBS
    12. Observation.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC).

    Fixed ValueEVN
    14. Observation.id
    Comments

    SHALL contain at least one [1..*] id.

    Control1..?
    16. Observation.code
    ShortAdvance directive/living will completed
    18. Observation.code.code
    Control1..?
    Pattern Value45473-6
    20. Observation.code.codeSystem
    ShortLOINC
    Control1..?
    Pattern Value2.16.840.1.113883.6.1
    22. Observation.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    Control1..?
    24. Observation.text.reference
    Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
    26. Observation.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode.

    Control1..?
    28. Observation.statusCode.code
    Comments

    This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC).

    Control1..?
    Fixed Valuecompleted
    30. Observation.effectiveTime
    ShortNote: This template represents a "snapshot in time" observation. As a result, the effectiveTime is constrained to just a time stamp.
    Comments

    SHALL contain exactly one [1..1] effectiveTime.

    Control1..?
    Invariantsvalue-only: Interval fields SHALL NOT be present ((low | high | width | center).empty())
    32. Observation.effectiveTime.value
    Shortvalue should be used instead of low/high
    34. Observation.value
    Control1..1
    BindingThe codes SHALL be taken from Answer Set with Yes No and Unknowns .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.16)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/SC
    36. Observation.author
    Comments

    SHALL contain exactly [1..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Provenance - Author Participation)
    38. Observation.informant
    ShortMAY contain zero or one [0..1] informant
    Control0..1
    40. Observation.entryRelationship
    Comments

    MAY contain zero or more [0..*] entryRelationship.

    42. Observation.entryRelationship.observation
    Comments

    SHALL contain exactly one [1..1] Advance Directive Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.48:2025-05-01).

    Control1..?
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Advance Directive Observation)