Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 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: Nutrition Section

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/NutritionSection Version: 4.0.0-ballot
Draft as of 2024-11-21 Computable Name: NutritionSection
Other Identifiers: OID:2.16.840.1.113883.10.20.22.2.57

The Nutrition Section represents diet and nutrition information including special diet requirements and restrictions (e.g., texture modified diet, liquids only, enteral feeding). It also represents the overall nutritional status of the patient and nutrition assessment findings.

Usage:

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-nutritional-status-obs: SHOULD contain Nutritional Status Observation
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.57
..... @extension 0..0
... code 1..1 CE Diet and nutrition Narrative
.... @code 1..1 cs Required Pattern: 61144-2
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
.... entry:nutritionalStatus 0..* Entry
..... observation 1..1 NutritionalStatusObservation Base for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
should-nutritional-status-obswarningSectionSHOULD contain Nutritional Status Observation
: entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NutritionalStatusObservation'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-nutritional-status-obs: SHOULD contain Nutritional Status Observation
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.57
... code 1..1 CE Diet and nutrition Narrative
Binding: DocumentSectionType (example)
.... @code 1..1 cs Required Pattern: 61144-2
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
.... entry:nutritionalStatus 0..* Entry
..... observation C 1..1 NutritionalStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Section.codeexampleDocumentSectionType
http://terminology.hl7.org/ValueSet/v3-DocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
should-nutritional-status-obswarningSectionSHOULD contain Nutritional Status Observation
: entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NutritionalStatusObservation'))
should-text-ref-valuewarningSection.entry:nutritionalStatus.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-nutritional-status-obs: SHOULD contain Nutritional Status Observation
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:section 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.57
... @ID 0..1 xs:ID
... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..1 II
... code 1..1 CE Diet and nutrition Narrative
Binding: DocumentSectionType (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: 61144-2
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... translation 0..* CD
... title 1..1 ST
... text 1..1 xhtml
... confidentialityCode 0..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... author 0..* Author
... informant 0..* Informant
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
.... entry:nutritionalStatus 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation C 1..1 NutritionalStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... component 0..* InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Fixed Value: COMP
.... @contextConductionInd 0..1 bl Fixed Value: true
.... section 1..1 Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Section.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.templateId:section.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.classCoderequiredFixed Value: DOCSECT
http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer
Section.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Section.codeexampleDocumentSectionType
http://terminology.hl7.org/ValueSet/v3-DocumentSectionType
Section.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Section.entry:nutritionalStatus.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.entry:nutritionalStatus.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.entry:nutritionalStatus.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
Section.component.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.component.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

IdGradePath(s)DetailsRequirements
should-nutritional-status-obswarningSectionSHOULD contain Nutritional Status Observation
: entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NutritionalStatusObservation'))
should-text-ref-valuewarningSection.entry:nutritionalStatus.observationSHOULD contain text/reference/@value
: text.reference.value.exists()

This structure is derived from Section

Summary

Mandatory: 8 elements(1 nested mandatory element)
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Section.templateId
  • The element 1 is sliced based on the value of Section.entry

Differential View

This structure is derived from Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-nutritional-status-obs: SHOULD contain Nutritional Status Observation
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.57
..... @extension 0..0
... code 1..1 CE Diet and nutrition Narrative
.... @code 1..1 cs Required Pattern: 61144-2
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
.... entry:nutritionalStatus 0..* Entry
..... observation 1..1 NutritionalStatusObservation Base for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
should-nutritional-status-obswarningSectionSHOULD contain Nutritional Status Observation
: entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NutritionalStatusObservation'))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-nutritional-status-obs: SHOULD contain Nutritional Status Observation
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.57
... code 1..1 CE Diet and nutrition Narrative
Binding: DocumentSectionType (example)
.... @code 1..1 cs Required Pattern: 61144-2
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
.... entry:nutritionalStatus 0..* Entry
..... observation C 1..1 NutritionalStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Section.codeexampleDocumentSectionType
http://terminology.hl7.org/ValueSet/v3-DocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
should-nutritional-status-obswarningSectionSHOULD contain Nutritional Status Observation
: entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NutritionalStatusObservation'))
should-text-ref-valuewarningSection.entry:nutritionalStatus.observationSHOULD contain text/reference/@value
: text.reference.value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-nutritional-status-obs: SHOULD contain Nutritional Status Observation
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:section 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.57
... @ID 0..1 xs:ID
... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..1 II
... code 1..1 CE Diet and nutrition Narrative
Binding: DocumentSectionType (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: 61144-2
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... translation 0..* CD
... title 1..1 ST
... text 1..1 xhtml
... confidentialityCode 0..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... author 0..* Author
... informant 0..* Informant
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation
.... entry:nutritionalStatus 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation C 1..1 NutritionalStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... component 0..* InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Fixed Value: COMP
.... @contextConductionInd 0..1 bl Fixed Value: true
.... section 1..1 Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Section.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.templateId:section.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.classCoderequiredFixed Value: DOCSECT
http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer
Section.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Section.codeexampleDocumentSectionType
http://terminology.hl7.org/ValueSet/v3-DocumentSectionType
Section.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Section.entry:nutritionalStatus.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.entry:nutritionalStatus.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.entry:nutritionalStatus.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
Section.component.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Section.component.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

IdGradePath(s)DetailsRequirements
should-nutritional-status-obswarningSectionSHOULD contain Nutritional Status Observation
: entry.where(observation.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NutritionalStatusObservation'))
should-text-ref-valuewarningSection.entry:nutritionalStatus.observationSHOULD contain text/reference/@value
: text.reference.value.exists()

This structure is derived from Section

Summary

Mandatory: 8 elements(1 nested mandatory element)
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Section.templateId
  • The element 1 is sliced based on the value of Section.entry

 

Other representations of profile: CSV, Excel