Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Nutrition Recommendation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/NutritionRecommendation Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: NutritionRecommendation
Other Identifiers: id: urn: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 Profile Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML 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..*IISlice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.130
..... @extension 0..0
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... encounter 1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedMedActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1PlannedMedicationActivityBase for all types and resources
.... entryRelationship:plannedObs 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProc 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... procedure 1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1PlannedSupplyBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1PlannedActBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codepreferredNutritionRecommendations

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 C1..1ActXML 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..*IISlice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.130
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedMedActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1PlannedMedicationActivityBase for all types and resources
.... entryRelationship:plannedObs 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProc 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1PlannedSupplyBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1PlannedActBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codepreferredNutritionRecommendations
Act.statusCoderequiredActStatus
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObs.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR

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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-targetSiteCodewarningAct.entryRelationship:plannedObs.observationSHOULD contain targetSiteCode
: targetSiteCode.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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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 C1..1ActXML 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..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:nutrition-rec 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.130
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... @negationInd 0..1bl
... id 0..*II
... code 1..1CDBinding: Nutrition Recommendations (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TSThe effectiveTime indicates the time when the activity is intended to take place.
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter C1..1PlannedEncounterBase for all types and resources
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedMedActivity 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration C1..1PlannedMedicationActivityBase for all types and resources
..... supply 0..1Supply
.... entryRelationship:plannedObs 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1PlannedObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedProc 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure C1..1PlannedProcedureBase for all types and resources
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply C1..1PlannedSupplyBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1PlannedActBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:nutrition-rec.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codepreferredNutritionRecommendations
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObs.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObs.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObs.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProc.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProc.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR

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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-targetSiteCodewarningAct.entryRelationship:plannedObs.observationSHOULD contain targetSiteCode
: targetSiteCode.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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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 (6 nested mandatory elements)
Fixed Value: 8 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the values of profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation

Differential View

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML 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..*IISlice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.130
..... @extension 0..0
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... encounter 1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedMedActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1PlannedMedicationActivityBase for all types and resources
.... entryRelationship:plannedObs 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProc 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... procedure 1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1PlannedSupplyBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1PlannedActBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codepreferredNutritionRecommendations

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 C1..1ActXML 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..*IISlice: Unordered, Open by value:root
.... templateId:nutrition-rec 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.130
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime indicates the time when the activity is intended to take place.
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedMedActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1PlannedMedicationActivityBase for all types and resources
.... entryRelationship:plannedObs 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProc 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1PlannedSupplyBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1PlannedActBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codepreferredNutritionRecommendations
Act.statusCoderequiredActStatus
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObs.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR

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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-targetSiteCodewarningAct.entryRelationship:plannedObs.observationSHOULD contain targetSiteCode
: targetSiteCode.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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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 C1..1ActXML 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..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:nutrition-rec 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.130
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... @negationInd 0..1bl
... id 0..*II
... code 1..1CDBinding: Nutrition Recommendations (preferred)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TSThe effectiveTime indicates the time when the activity is intended to take place.
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter C1..1PlannedEncounterBase for all types and resources
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedMedActivity 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration C1..1PlannedMedicationActivityBase for all types and resources
..... supply 0..1Supply
.... entryRelationship:plannedObs 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1PlannedObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedProc 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure C1..1PlannedProcedureBase for all types and resources
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply C1..1PlannedSupplyBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1PlannedActBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:nutrition-rec.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codepreferredNutritionRecommendations
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObs.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObs.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObs.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProc.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProc.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProc.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR

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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-targetSiteCodewarningAct.entryRelationship:plannedObs.observationSHOULD contain targetSiteCode
: targetSiteCode.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:plannedObs.observation, Act.entryRelationship:plannedProc.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:plannedAct.actSHOULD 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 (6 nested mandatory elements)
Fixed Value: 8 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the values of profile:act, profile:encounter, profile:substanceAdministration, profile:supply, profile:procedure, profile:observation

 

Other representations of profile: CSV, Excel