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

Draft as of 2024-12-19

Definitions for the AllergyConcernAct 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())
1198-10085: If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). ((statusCode.code = 'completed') implies effectiveTime.high.exists())
1198-7504: If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). ((statusCode.code = 'active') implies effectiveTime.low.exists())
should-author: SHOULD contain author (author.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:allergy-concern-act
    Slice Nameallergy-concern-act
    Control1..1
    6. Act.templateId:allergy-concern-act.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.30
    8. Act.templateId:allergy-concern-act.extension
    Control1..?
    Pattern Value2015-08-01
    10. Act.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-7469).

    Fixed ValueACT
    12. Act.moodCode
    Comments

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

    Fixed ValueEVN
    14. Act.id
    Comments

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

    Control1..?
    16. Act.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:1198-7477).

    18. Act.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="CONC" Concern (CONF:1198-19158).

    Control1..?
    Pattern ValueCONC
    20. Act.code.codeSystem
    Comments

    This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.6" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-32154).

    Control1..?
    Pattern Value2.16.840.1.113883.5.6
    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:1198-7485).

    Control1..?
    28. Act.statusCode.nullFlavor
    Control0..0
    30. Act.statusCode.code
    Control1..?
    BindingThe codes SHALL be taken from ProblemAct statusCode .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.19)
    32. Act.effectiveTime
    Comments

    SHALL contain exactly one [1..1] effectiveTime (CONF:1198-7498).

    Control1..?
    34. Act.effectiveTime.low
    ShortRequired if statusCode = 'active'
    36. Act.effectiveTime.high
    ShortRequired if statusCode = 'completed'
    38. Act.author
    Comments

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

    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
    40. 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:
    • profile @ observation
    • 42. Act.entryRelationship:allergyObs
      Slice NameallergyObs
      Comments

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

      Control1..1
      44. Act.entryRelationship:allergyObs.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-7915).

      Fixed ValueSUBJ
      46. Act.entryRelationship:allergyObs.observation
      Comments

      SHALL contain exactly one [1..1] Allergy - Intolerance Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.7:2014-06-09) (CONF:1198-14925).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Allergy - Intolerance Observation)