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

Draft as of 2024-12-19

Definitions for the PlannedCoverage logical model.

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

0. Act
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. Act.templateId
Control1..?
SlicingThis element introduces a set of slices on Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Act.templateId:planned-coverage
    Slice Nameplanned-coverage
    Control1..1
    6. Act.templateId:planned-coverage.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.129
    8. Act.templateId:planned-coverage.extension
    Control1..?
    Pattern Value2024-05-01
    10. Act.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="ACT" act (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-31945).

    Fixed ValueACT
    12. Act.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="INT" Intent (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31946).

    Fixed ValueINT
    14. Act.id
    Comments

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

    Control1..?
    16. Act.code
    ShortPayment sources
    Comments

    SHALL contain exactly one [1..1] code (CONF:1098-31951).

    18. Act.code.code
    Control1..?
    Pattern Value52556-8
    20. Act.code.codeSystem
    ShortLOINC
    Control1..?
    Pattern Value2.16.840.1.113883.6.1
    22. Act.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    24. Act.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. Act.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:1098-31954).

    Control1..?
    28. Act.statusCode.code
    Comments

    This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-31955).

    Control1..?
    Fixed Valueactive
    30. Act.author
    Comments

    MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32178).

    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
    32. Act.entryRelationship
    Control1..?
    SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • exists @ act
    • 34. Act.entryRelationship:entryRelationship1
      Slice NameentryRelationship1
      Comments

      SHALL contain exactly one [1..1] entryRelationship (CONF:1098-31967) such that it

      Control1..1
      36. Act.entryRelationship:entryRelationship1.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="COMP" has component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31968).

      Fixed ValueCOMP
      38. Act.entryRelationship:entryRelationship1.act
      Comments

      SHALL contain exactly one [1..1] act (CONF:1098-31969).

      Control1..?
      40. Act.entryRelationship:entryRelationship1.act.classCode
      Comments

      This act SHALL contain exactly one [1..1] @classCode="ACT" ACT (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31970).

      Fixed ValueACT
      42. Act.entryRelationship:entryRelationship1.act.moodCode
      Comments

      This act SHALL contain exactly one [1..1] @moodCode="INT" intent (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31971).

      Fixed ValueINT
      44. Act.entryRelationship:entryRelationship1.act.id
      ShortThese act/identifiers are unique identifiers for the policy or program providing the coverage.
      Comments

      This act SHALL contain at least one [1..*] id (CONF:1098-31972).

      Control1..?
      46. Act.entryRelationship:entryRelationship1.act.code
      Comments

      This act SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Payer urn:oid:2.16.840.1.114222.4.11.3591 DYNAMIC (CONF:1098-31973).

      BindingThe codes SHALL be taken from Payer Type .
      (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591)
      48. Act.entryRelationship:entryRelationship1.act.statusCode
      Comments

      This act SHALL contain exactly one [1..1] statusCode (CONF:1098-31974).

      Control1..?
      50. Act.entryRelationship:entryRelationship1.act.statusCode.code
      Comments

      This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31975).

      Control1..?
      Fixed Valueactive