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

Draft as of 2024-12-19

Definitions for the NutritionRecommendation 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())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.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
  • 4. Act.templateId:nutrition-rec
    Slice Namenutrition-rec
    Control1..1
    6. Act.templateId:nutrition-rec.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.130
    8. Act.templateId:nutrition-rec.extension
    Control0..0
    10. Act.classCode
    Comments

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

    Fixed ValueACT
    12. Act.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-30386).

    BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure) .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23)
    14. Act.code
    Comments

    SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Nutrition Recommendation Grouping urn:oid:2.16.840.1.113762.1.4.1095.65.

    BindingThe codes SHOULD be taken from Nutrition Recommendation Grouping .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1095.65)
    16. Act.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    18. 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('#'))
    20. Act.statusCode
    Comments

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

    Control1..?
    22. 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-31698).

    Control1..?
    Fixed Valueactive
    24. Act.effectiveTime
    ShortThe effectiveTime indicates the time when the activity is intended to take place.
    Comments

    SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-31699).

    26. Act.entryRelationship
    SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • profile @ act
    • profile @ encounter
    • profile @ substanceAdministration
    • profile @ supply
    • profile @ procedure
    • 28. Act.entryRelationship:plannedEncounter
      Slice NameplannedEncounter
      Comments

      MAY contain zero or more [0..*] entryRelationship (CONF:1098-32382) such that it

      Control0..*
      30. Act.entryRelationship:plannedEncounter.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32928).

      Fixed ValueREFR
      32. Act.entryRelationship:plannedEncounter.encounter
      Comments

      SHALL contain exactly one [1..1] Planned Encounter (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.40:2014-06-09) (CONF:1098-32383).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter(Planned Encounter)
      34. Act.entryRelationship:plannedMedActivity
      Slice NameplannedMedActivity
      Comments

      MAY contain zero or more [0..*] entryRelationship (CONF:1098-32384) such that it

      Control0..*
      36. Act.entryRelationship:plannedMedActivity.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32929).

      Fixed ValueREFR
      38. Act.entryRelationship:plannedMedActivity.substanceAdministration
      Comments

      SHALL contain exactly one [1..1] Planned Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.42:2014-06-09) (CONF:1098-32385).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Planned Medication Activity)
      40. Act.entryRelationship:plannedProc
      Slice NameplannedProc
      Comments

      MAY contain zero or more [0..*] entryRelationship (CONF:1098-32388) such that it

      Control0..*
      42. Act.entryRelationship:plannedProc.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32931).

      Fixed ValueREFR
      44. Act.entryRelationship:plannedProc.procedure
      Comments

      SHALL contain exactly one [1..1] Planned Procedure (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.41:2014-06-09) (CONF:1098-32389).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure(Planned Procedure)
      46. Act.entryRelationship:plannedSupply
      Slice NameplannedSupply
      Comments

      MAY contain zero or more [0..*] entryRelationship (CONF:1098-32390) such that it

      Control0..*
      48. Act.entryRelationship:plannedSupply.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32932).

      Fixed ValueREFR
      50. Act.entryRelationship:plannedSupply.supply
      Comments

      SHALL contain exactly one [1..1] Planned Supply (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.43:2014-06-09) (CONF:1098-32391).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Planned Supply)