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

Draft as of 2024-12-19

Definitions for the ProvenanceAuthorParticipation logical model.

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

0. Author
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.
2. Author.templateId
Control1..?
SlicingThis element introduces a set of slices on Author.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Author.templateId:provenance-author
    Slice Nameprovenance-author
    Control1..1
    6. Author.templateId:provenance-author.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.5.6
    8. Author.templateId:provenance-author.extension
    Control1..?
    Pattern Value2019-10-01
    10. Author.time
    Short𝗨𝗦𝗖𝗗𝗜: Author Time Stamp
    Comments

    SHALL contain exactly one [1..1] time (CONF:4515-32983).

    12. Author.assignedAuthor
    Comments

    SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975).

    Invariantsauthor-details: Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. (nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists()))))
    4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). (representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension))))
    should-code: SHOULD contain code (code.exists())
    14. Author.assignedAuthor.id
    Comments

    This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2).

    SlicingThis element introduces a set of slices on Author.assignedAuthor.id. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ root
    • 16. Author.assignedAuthor.id:npi
      Slice Namenpi
      Comments

      This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it

      Control1..1
      18. Author.assignedAuthor.id:npi.nullFlavor
      ShortIf NPI is unknown, set @nullFlavor to UNK
      20. Author.assignedAuthor.id:npi.root
      Comments

      SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-22).

      Control1..?
      Pattern Value2.16.840.1.113883.4.6
      22. Author.assignedAuthor.id:npi.extension
      Comments

      SHOULD contain zero or one [0..1] @extension (CONF:4515-23).

      24. Author.assignedAuthor.code
      Short𝗨𝗦𝗖𝗗𝗜: Author Role - When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.
      Comments

      This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4515-32979).

      BindingFor example codes, see CDARoleCode
      (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode)

      See additional bindings

      26. Author.assignedAuthor.addr
      ShortRequired on at least one instance of this author in the document
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
      28. Author.assignedAuthor.telecom
      ShortRequired on at least one instance of this author in the document
      30. Author.assignedAuthor.assignedPerson
      Short𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
      32. Author.assignedAuthor.assignedPerson.name
      Comments

      The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977).

      Control1..?
      Invariantsshall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
      should-given: SHOULD contain given (item.given.exists())
      34. Author.assignedAuthor.assignedPerson.name.item
      36. Author.assignedAuthor.assignedPerson.name.item.family
      ShortFamily required
      Comments

      Such names SHALL contain exactly one [1..1] family (CONF:4515-17).

      38. Author.assignedAuthor.assignedPerson.name.item.given
      ShortSHOULD contain given
      Comments

      Such names SHOULD contain zero or more [0..*] given (CONF:4515-18).

      40. Author.assignedAuthor.assignedAuthoringDevice
      Comments

      This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32).

      42. Author.assignedAuthor.representedOrganization
      Short𝗨𝗦𝗖𝗗𝗜: Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64).
      Comments

      This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:4515-32978).

      Invariantsprovenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. (nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists()))
      44. Author.assignedAuthor.representedOrganization.nullFlavor
      ShortA nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
      Comments

      The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35).

      46. Author.assignedAuthor.representedOrganization.id
      Comments

      The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981).

      SlicingThis element introduces a set of slices on Author.assignedAuthor.representedOrganization.id. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ root
      • 48. Author.assignedAuthor.representedOrganization.id:taxId
        Slice NametaxId
        Comments

        The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it

        Control0..1
        50. Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor
        ShortIf Tax ID Number is unknown, set @nullFlavor to UNK
        52. Author.assignedAuthor.representedOrganization.id:taxId.root
        Comments

        SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.2" Tax ID Number (CONF:4515-26).

        Control1..?
        Pattern Value2.16.840.1.113883.4.2
        54. Author.assignedAuthor.representedOrganization.id:taxId.extension
        Comments

        SHOULD contain zero or one [0..1] @extension (CONF:4515-32982).

        56. Author.assignedAuthor.representedOrganization.id:npi
        Slice Namenpi
        Comments

        The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it

        Control0..1
        58. Author.assignedAuthor.representedOrganization.id:npi.nullFlavor
        ShortIf NPI is unknown, set @nullFlavor to UNK
        60. Author.assignedAuthor.representedOrganization.id:npi.root
        Comments

        SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-30).

        Control1..?
        Pattern Value2.16.840.1.113883.4.6
        62. Author.assignedAuthor.representedOrganization.id:npi.extension
        Comments

        SHOULD contain zero or one [0..1] @extension (CONF:4515-31).

        64. Author.assignedAuthor.representedOrganization.name
        Comments

        The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11).

        Control0..1
        66. Author.assignedAuthor.representedOrganization.telecom
        Comments

        The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12).