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: Reason - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the Reason 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())
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:reason
    Slice Namereason
    Control1..1
    6. Observation.templateId:reason.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.24.3.88
    8. Observation.templateId:reason.extension
    Control1..?
    Pattern Value2023-05-01
    10. Observation.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-11357).

    Fixed ValueOBS
    12. Observation.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4537-11358).

    Fixed ValueEVN
    14. Observation.id
    Comments

    SHALL contain at least one [1..*] id (CONF:4537-26998).

    Control1..?
    16. Observation.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:4537-11361).

    18. Observation.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="77301-0" Reason care action performed or not (CONF:4537-11362).

    Control1..?
    Pattern Value77301-0
    20. Observation.code.codeSystem
    Comments

    This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:4537-27028).

    Control1..?
    Pattern Value2.16.840.1.113883.6.1
    22. Observation.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    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 (CONF:4537-11364).

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

    This statusCode SHALL contain exactly one [1..1] @code="completed" (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4537-11365).

    Control1..?
    Fixed Valuecompleted
    30. Observation.effectiveTime
    Comments

    SHALL contain exactly one [1..1] effectiveTime (CONF:4537-11366).

    Control1..?
    32. Observation.effectiveTime.low
    Comments

    This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-27551).

    Control1..?
    34. Observation.effectiveTime.high
    Comments

    This effectiveTime MAY contain zero or one [0..1] high (CONF:4537-27552).

    36. Observation.value
    Comments

    SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:4537-11367).

    Control1..1
    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