Consolidated CDA (C-CDA)
3.0.0 - STU 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 3.0.0 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 Recommendation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/NutritionRecommendation Version: 3.0.0
Draft as of 2024-05-07 Computable Name: NutritionRecommendation
Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.130

This template represents nutrition regimens (e.g., fluid restrictions, calorie minimum), interventions (e.g., NPO, nutritional supplements), and procedures (e.g., G-Tube by bolus, TPN by central line). It may also depict the need for nutrition education.

Usage:

Formal Views of Template Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.130
..... @extension 0..0
... @classCode 1..1 cs Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS The effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... encounter 1..1 PlannedEncounter Base for all types and resources
.... entryRelationship:plannedMedActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 PlannedMedicationActivity Base for all types and resources
.... entryRelationship:plannedProc 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... procedure 1..1 PlannedProcedure Base for all types and resources
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... supply 1..1 PlannedSupply Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Act.codepreferredNutritionRecommendationGrouping .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1095.65

Constraints

IdGradePath(s)DetailsRequirements
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.130
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS The effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedMedActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
.... entryRelationship:plannedProc 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Act.codepreferredNutritionRecommendationGrouping .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1095.65
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorAct.entryRelationship:plannedMedActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
... @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:nutrition-rec 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.4.130
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... @negationInd 0..1 bl
... id 0..* II
... code 1..1 CD Binding: Nutrition Recommendation Grouping . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @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)
... effectiveTime 0..1 IVL_TS The effectiveTime indicates the time when the activity is intended to take place.
... priorityCode 0..1 CE Binding: ActPriority (example)
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedMedActivity 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:plannedProc 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:nutrition-rec.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Act.codepreferredNutritionRecommendationGrouping .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1095.65
Act.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Act.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Act.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProc.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorAct.entryRelationship:plannedMedActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 5 elements(4 nested mandatory elements)
Fixed: 6 elements
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 Act.templateId
  • The element 5 is sliced based on the values of Act.entryRelationship

Differential View

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.130
..... @extension 0..0
... @classCode 1..1 cs Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS The effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... encounter 1..1 PlannedEncounter Base for all types and resources
.... entryRelationship:plannedMedActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 PlannedMedicationActivity Base for all types and resources
.... entryRelationship:plannedProc 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... procedure 1..1 PlannedProcedure Base for all types and resources
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... supply 1..1 PlannedSupply Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Act.codepreferredNutritionRecommendationGrouping .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1095.65

Constraints

IdGradePath(s)DetailsRequirements
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.130
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS The effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedMedActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
.... entryRelationship:plannedProc 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Act.codepreferredNutritionRecommendationGrouping .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1095.65
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorAct.entryRelationship:plannedMedActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
... @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:nutrition-rec 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.4.130
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned moodCode (Act/Encounter/Procedure) . (required)
... @negationInd 0..1 bl
... id 0..* II
... code 1..1 CD Binding: Nutrition Recommendation Grouping . (preferred)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @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)
... effectiveTime 0..1 IVL_TS The effectiveTime indicates the time when the activity is intended to take place.
... priorityCode 0..1 CE Binding: ActPriority (example)
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedMedActivity 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:plannedProc 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @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 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:nutrition-rec.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.23
Act.codepreferredNutritionRecommendationGrouping .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1095.65
Act.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Act.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Act.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProc.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorAct.entryRelationship:plannedMedActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedMedActivity.substanceAdministration, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 5 elements(4 nested mandatory elements)
Fixed: 6 elements
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 Act.templateId
  • The element 5 is sliced based on the values of Act.entryRelationship

 

Other representations of profile: CSV, Excel