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

Draft as of 2024-12-19

Definitions for the Indication 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())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. (value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and 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:indication
    Slice Nameindication
    Control1..1
    6. Observation.templateId:indication.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.19
    8. Observation.templateId:indication.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 STATIC) (CONF:4537-7480).

    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 STATIC) (CONF:4537-7481).

    Fixed ValueEVN
    14. Observation.id
    ShortIf the id element is used to reference a problem recorded elsewhere in the document then this id must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. Its purpose is to obviate the need to repeat the complete XML representation of the referred to entry when relating one entry to another.
    Comments

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

    Control1..?
    16. Observation.code
    Comments

    SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Problem Type urn:oid:2.16.840.1.113762.1.4.1267.1.

    BindingThe codes SHOULD be taken from Problem Type .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.1)
    18. Observation.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    20. 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('#'))
    22. Observation.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:4537-7487).

    Control1..?
    24. 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) (CONF:4537-19105).

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

    SHOULD contain zero or one [0..1] effectiveTime (CONF:4537-7488).

    28. Observation.value
    ShortIf the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry.
    Comments

    MAY contain zero or one [0..1] value with @xsi:type="CD", where the code MAY be selected from ValueSet US Core Condition Codes.

    Control0..1
    BindingThe codes SHOULD be taken from US Core Condition Codes
    (preferred to http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code)
    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