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

Draft as of 2024-12-19

Definitions for the NoteActivity 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:note-activity
    Slice Namenote-activity
    Control1..1
    6. Act.templateId:note-activity.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.202
    8. Act.templateId:note-activity.extension
    Control1..?
    Pattern Value2016-11-01
    10. Act.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="ACT" Act (CONF:3250-16899).

    Fixed ValueACT
    12. Act.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="EVN" Event (CONF:3250-16900).

    Fixed ValueEVN
    14. Act.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:3250-16895).

    Invariantsshould-translation: SHOULD contain translation (translation.exists())
    16. Act.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="34109-9" Note (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:3250-16940).

    Control1..?
    Pattern Value34109-9
    18. Act.code.codeSystem
    Comments

    This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" LOINC (CONF:3250-16941).

    Control1..?
    Pattern Value2.16.840.1.113883.6.1
    20. Act.code.translation
    ShortIf the Note Activity is within a narrative-only section (e.g. Hospital Course), the translation MAY match the section code (CONF:3250-16943). If the Note Activity is within a Note Section, the translation SHOULD match or specialize the section code (CONF:3250-16942).
    Comments

    This code SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Note Types urn:oid:2.16.840.1.113883.11.20.9.68 DYNAMIC (CONF:3250-16939).

    BindingThe codes SHOULD be taken from Note Types .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.68)
    22. Act.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    Comments

    SHALL contain exactly one [1..1] text (CONF:3250-16896).

    Control1..?
    Invariants3250-16912: If @mediaType is present, the text SHALL contain exactly one [1..1] @representation="B64" and mixed content corresponding to the contents of the note (CONF:3250-16912). (mediaType.exists() implies (representation = 'B64' and xmlText.exists()))
    24. Act.text.mediaType
    ShortIf the note was originally in another format, such as RTF, this element may also contain the base-64-encoded raw data of the note in addition to a reference to the narrative.
    Comments

    This text MAY contain zero or one [0..1] @mediaType, which SHOULD be selected from ValueSet SupportedFileFormats urn:oid:2.16.840.1.113883.11.20.7.1 DYNAMIC (CONF:3250-16906).

    BindingThe codes SHOULD be taken from SupportedFileFormats .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.7.1)
    26. Act.text.reference
    Comments

    This text SHALL contain exactly one [1..1] reference (CONF:3250-16897).

    Control1..?
    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('#'))
    28. Act.text.reference.nullFlavor
    ShortThe note activity must reference human-readable content in the narrative, so this reference must not be null.
    Comments

    This reference SHALL NOT contain [0..0] @nullFlavor (CONF:3250-16920).

    Control0..0
    30. Act.text.reference.value
    Comments

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

    Control1..?
    32. Act.statusCode
    ShortIndicates the status of the note. The most common statusCode is completed indicating the note is signed and finalized.
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:3250-16916).

    Control1..?
    34. Act.effectiveTime
    ShortThe effectiveTime represents the clinically relevant time of the note. The precise timestamp of creation / updating should be conveyed in author/time.
    Comments

    SHALL contain exactly one [1..1] effectiveTime (CONF:3250-16903).

    Control1..?
    Invariantsshould-value-att: SHOULD contain @value (value.exists())
    36. Act.effectiveTime.value
    Comments

    This effectiveTime SHOULD contain zero or one [0..1] @value (CONF:3250-16917).

    38. Act.author
    ShortRepresents the person(s) who wrote the note.
    Comments

    SHALL contain at least one [1..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:3250-16913).

    Control1..?
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
    40. Act.participant
    Comments

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

    SlicingThis element introduces a set of slices on Act.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ typeCode
    • 42. Act.participant:legalAuthenticator
      Slice NamelegalAuthenticator
      ShortRepresents the person(s) legally responsible for the contents of the note.
      Control0..*
      44. Act.participant:legalAuthenticator.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="LA" Legal Authenticator (CONF:3250-16925).

      Fixed ValueLA
      46. Act.participant:legalAuthenticator.time
      ShortIndicates the time of signing the note.
      Comments

      SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:3250-16926).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
      48. Act.participant:legalAuthenticator.participantRole
      Comments

      SHALL contain exactly one [1..1] participantRole (CONF:3250-16924).

      Invariants3250-16930: If no id matches an author or participant elsewhere in the document, then playingEntity SHALL be present (CONF:3250-16930). ()
      50. Act.participant:legalAuthenticator.participantRole.id
      ShortThis may be the ID of the note author. If so, no additional information in this participant is required.
      Comments

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

      Control1..?
      52. Act.participant:legalAuthenticator.participantRole.playingEntity
      Comments

      This participantRole MAY contain zero or one [0..1] playingEntity (CONF:3250-16928).

      54. Act.participant:legalAuthenticator.participantRole.playingEntity.name
      Comments

      The playingEntity, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:3250-16929).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
      56. Act.entryRelationship
      Comments

      SHOULD contain zero or more [0..*] entryRelationship (CONF:3250-16907) such that it

      SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • exists @ encounter
      • 58. Act.entryRelationship:encounter
        Slice Nameencounter
        ShortLinks the note to an encounter. If the Note Activity is present within a document containing an encompassingEncounter, then this entryRelationship is optional and the note is associated with the encounter represented by the encompassingEncounter.
        Control0..*
        60. Act.entryRelationship:encounter.typeCode
        Comments

        SHALL contain exactly one [1..1] @typeCode="COMP" (CONF:3250-16921).

        Fixed ValueCOMP
        62. Act.entryRelationship:encounter.inversionInd
        Comments

        SHALL contain exactly one [1..1] @inversionInd="true" (CONF:3250-16922).

        Control1..?
        Fixed Valuetrue
        64. Act.entryRelationship:encounter.negationInd
        ShortTo communicate that the note is not associated with any encounter, this entryRelationship MAY be included with @negationInd="true" and encounter/id/@nullFlavor="NA". The negationInd + encounter indicate this note is not associated with any encounter.
        Comments

        MAY contain zero or one [0..1] @negationInd (CONF:3250-16931).

        66. Act.entryRelationship:encounter.encounter
        Comments

        SHALL contain exactly one [1..1] encounter (CONF:3250-16908).

        Control1..?
        68. Act.entryRelationship:encounter.encounter.id
        Comments

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

        Control1..?
        Invariants3250-16914: If the id does not match an encounter/id from the Encounters Section or encompassingEncounter 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:3250-16914). ()
        70. Act.reference
        Comments

        MAY contain zero or more [0..*] reference (CONF:3250-16910) such that it

        SlicingThis element introduces a set of slices on Act.reference. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • exists @ externalDocument
        • 72. Act.reference:externalDocument
          Slice NameexternalDocument
          ShortRepresents an unstructured C-CDA document containing the original contents of the note in the original format.
          Control0..*
          74. Act.reference:externalDocument.externalDocument
          Comments

          SHALL contain exactly one [1..1] externalDocument (CONF:3250-16911).

          Control1..?
          Invariantsshould-code: SHOULD contain code (code.exists())
          76. Act.reference:externalDocument.externalDocument.id
          Comments

          This externalDocument SHALL contain exactly one [1..1] id (CONF:3250-16915).

          Control1..1
          78. Act.reference:externalDocument.externalDocument.code
          Comments

          This externalDocument SHOULD contain zero or one [0..1] code (CONF:3250-16918).