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

Draft as of 2024-12-19

Definitions for the CaregiverCharacteristics 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
  • 4. Observation.templateId:caregiver-characteristics
    Slice Namecaregiver-characteristics
    Control1..1
    6. Observation.templateId:caregiver-characteristics.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.72
    8. Observation.templateId:caregiver-characteristics.extension
    Control0..0
    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:81-14219).

    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:81-14220).

    Fixed ValueEVN
    14. Observation.id
    Comments

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

    Control1..?
    16. Observation.code
    ShortThis code MAY be drawn from LOINC (CodeSystem: LOINC 2.16.840.1.113883.6.1) or MAY be bound to ASSERTION (CodeSystem: ActCode 2.16.840.1.113883.5.4 STATIC) (CONF:81-26513).
    Comments

    SHALL contain exactly one [1..1] code (CONF:81-14230).

    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:81-14233).

    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:81-19090).

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

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

    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
    Invariants81-14600: The code **SHALL** be selected from LOINC (codeSystem: 2.16.840.1.113883.6.1) or SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:81-14600). (codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96')
    28. Observation.participant
    Comments

    SHALL contain at least one [1..*] participant (CONF:81-14227).

    Control1..?
    30. Observation.participant.typeCode
    Comments

    Such participants SHALL contain exactly one [1..1] @typeCode="IND" (CONF:81-26451).

    Fixed ValueIND
    32. Observation.participant.time
    Comments

    Such participants MAY contain zero or one [0..1] time (CONF:81-14830).

    34. Observation.participant.time.low
    Comments

    The time, if present, SHALL contain exactly one [1..1] low (CONF:81-14831).

    Control1..?
    36. Observation.participant.time.high
    Comments

    The time, if present, MAY contain zero or one [0..1] high (CONF:81-14832).

    38. Observation.participant.participantRole
    Comments

    Such participants SHALL contain exactly one [1..1] participantRole (CONF:81-14228).

    40. Observation.participant.participantRole.classCode
    Comments

    This participantRole SHALL contain exactly one [1..1] @classCode="CAREGIVER" (CONF:81-14229).

    Control1..?
    Fixed ValueCAREGIVER