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

Draft as of 2024-12-19

Definitions for the CareTeamOrganizer logical model.

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

0. Organizer
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-sdtctext-ref-value: SHOULD contain text/reference/@value (sdtcText.reference.value.exists())
should-author: SHOULD contain author (author.exists())
2. Organizer.templateId
Control1..?
SlicingThis element introduces a set of slices on Organizer.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Organizer.templateId:care-team-org
    Slice Namecare-team-org
    Control1..1
    6. Organizer.templateId:care-team-org.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.500
    8. Organizer.templateId:care-team-org.extension
    Control1..?
    Pattern Value2022-06-01
    10. Organizer.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="CLUSTER" CLUSTER (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4515-124).

    Fixed ValueCLUSTER
    12. Organizer.moodCode
    Comments

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

    14. Organizer.id
    Comments

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

    Control1..?
    16. Organizer.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:4515-114).

    Control1..?
    18. Organizer.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="86744-0" Care Team (CONF:4515-120).

    Control1..?
    Pattern Value86744-0
    20. Organizer.code.codeSystem
    Comments

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

    Control1..?
    Pattern Value2.16.840.1.113883.6.1
    22. Organizer.code.originalText
    Comments

    This code SHOULD contain zero or one [0..1] originalText (CONF:4515-154) such that it

    24. Organizer.code.originalText.reference
    Comments

    SHALL contain exactly one [1..1] reference (CONF:4515-155).

    Control1..?
    26. Organizer.code.originalText.reference.value
    ShortThe value attribute references the narrative in section.text where the care team name is rendered. The intention of this reference is to clarify which care team this Organizer refers to.
    Comments

    This reference SHALL contain exactly one [1..1] @value (CONF:4515-156).

    Control1..?
    28. Organizer.sdtcText
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    30. Organizer.sdtcText.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('#'))
    32. Organizer.statusCode
    ShortWhen statusCode has a value set, its value MAY be rendered in the narrative.
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:4515-113).

    34. Organizer.statusCode.nullFlavor
    Control0..0
    36. Organizer.statusCode.code
    Control1..?
    BindingThe codes SHALL be taken from ActStatus
    (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
    38. Organizer.effectiveTime
    Comments

    SHALL contain exactly one [1..1] effectiveTime (CONF:4515-127).

    Control1..?
    40. Organizer.effectiveTime.low
    Comments

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

    Control1..?
    42. Organizer.effectiveTime.high
    Comments

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

    44. Organizer.author
    Comments

    SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4515-116).

    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
    46. Organizer.participant
    SlicingThis element introduces a set of slices on Organizer.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ typeCode
    • 48. Organizer.participant:lead
      Slice Namelead
      ShortThis Participant represents the Care Team lead.
      Comments

      SHOULD contain zero or more [0..*] participant (CONF:4515-128) such that it

      Control0..*
      50. Organizer.participant:lead.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="PPRF" Primary Performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:4515-129).

      Fixed ValuePPRF
      52. Organizer.participant:lead.sdtcFunctionCode
      ShortDescribes the person's, caregiver's or health care provider's functional role on the care team.
      Comments

      MAY contain zero or one [0..1] sdtc:functionCode, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4515-130).

      BindingThe codes SHOULD be taken from Care Team Member Function .
      (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30)
      54. Organizer.participant:lead.participantRole
      Comments

      SHALL contain exactly one [1..1] participantRole (CONF:4515-131).

      56. Organizer.participant:lead.participantRole.id
      Comments

      This participantRole SHALL contain at least one [1..*] id (CONF:4515-132).

      Control1..?
      Invariants4515-133: This id **SHALL** match a performer/assignedEntity/id of at least one Care Team Member described in component/act (CONF:4515-133). ()
      58. Organizer.participant:location
      Slice Namelocation
      Shortparticipant
      Comments

      MAY contain zero or more [0..*] participant (CONF:4515-134) such that it

      Control0..*
      60. Organizer.participant:location.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="LOC" Location (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:4515-137).

      Fixed ValueLOC
      62. Organizer.participant:location.participantRole
      Comments

      SHALL contain exactly one [1..1] participantRole (CONF:4515-135).

      Invariantsshould-addr: SHOULD contain addr (addr.exists())
      should-telecom: SHOULD contain telecom (telecom.exists())
      64. Organizer.participant:location.participantRole.id
      Comments

      This participantRole SHALL contain at least one [1..*] id (CONF:4515-138).

      Control1..?
      66. Organizer.participant:location.participantRole.addr
      Comments

      This participantRole SHOULD contain zero or one [0..1] addr (CONF:4515-139).

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
      68. Organizer.participant:location.participantRole.telecom
      Comments

      This participantRole SHOULD contain zero or more [0..*] telecom (CONF:4515-140).

      70. Organizer.participant:location.participantRole.playingEntity
      Comments

      This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:4515-136).

      Control1..?
      72. Organizer.participant:location.participantRole.playingEntity.classCode
      Comments

      This playingEntity SHALL contain exactly one [1..1] @classCode="PLC" Place (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41) (CONF:4515-141).

      Control1..?
      Fixed ValuePLC
      74. Organizer.participant:location.participantRole.playingEntity.name
      Comments

      This playingEntity SHALL contain exactly one [1..1] name (CONF:4515-142).

      Control1..1
      76. Organizer.component
      Comments

      SHALL contain at least one [1..*] component (CONF:4515-152) such that it

      Control1..?
      SlicingThis element introduces a set of slices on Organizer.component. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • profile @ act
      • profile @ observation
      • exists @ encounter
      • 78. Organizer.component:type
        Slice Nametype
        Shortcomponent
        Comments

        MAY contain zero or more [0..*] component (CONF:4515-110) such that it

        Control0..*
        80. Organizer.component:type.act
        Control0..0
        82. Organizer.component:type.encounter
        Control0..0
        84. Organizer.component:type.observation
        Comments

        SHALL contain exactly one [1..1] Care Team Type Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.500.2:2019-07-01) (CONF:4515-163).

        Control1..?
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Care Team Type Observation)
        86. Organizer.component:entryReference
        Slice NameentryReference
        ShortThe following components represent the reasons for the existence of the care team. These entry references are typically a health concern, risk concern or problem but can also be some other entry present in the document.
        Comments

        MAY contain zero or more [0..*] component (CONF:4515-146) such that it

        Control0..*
        88. Organizer.component:entryReference.act
        Comments

        SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:4515-147).

        Control1..?
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
        90. Organizer.component:entryReference.encounter
        Control0..0
        92. Organizer.component:entryReference.observation
        Control0..0
        94. Organizer.component:encounter
        Slice Nameencounter
        Shortcomponent
        Comments

        MAY contain zero or more [0..*] component (CONF:4515-148) such that it

        Control0..*
        96. Organizer.component:encounter.act
        Control0..0
        98. Organizer.component:encounter.encounter
        Comments

        SHALL contain exactly one [1..1] encounter (CONF:4515-164).

        Control1..?
        100. Organizer.component:encounter.encounter.id
        Short1. If the id does not match an encounter/id from an encounter elsewhere within the same document and the id does not contain @nullFlavor=NA, then this entry SHALL conform to the Encounter Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01) (CONF:4435-145).
        Comments

        This encounter SHALL contain at least one [1..*] id (CONF:4515-165).

        Control1..?
        102. Organizer.component:encounter.observation
        Control0..0
        104. Organizer.component:note
        Slice Namenote
        Shortcomponent
        Comments

        MAY contain zero or one [0..1] component (CONF:4515-150) such that it

        Control0..1
        106. Organizer.component:note.act
        Comments

        SHALL contain exactly one [1..1] Note Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.202:2016-11-01) (CONF:4515-151).

        Control1..?
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Note Activity)
        108. Organizer.component:note.encounter
        Control0..0
        110. Organizer.component:note.observation
        Control0..0
        112. Organizer.component:member
        Slice Namemember
        Shortcomponent
        Control1..*
        114. Organizer.component:member.act
        Comments

        SHALL contain exactly one [1..1] Care Team Member Act (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.500.1:2022-06-01) (CONF:4515-166).

        Control1..?
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Care Team Member Act)
        116. Organizer.component:member.encounter
        Control0..0
        118. Organizer.component:member.observation
        Control0..0