Consolidated CDA (C-CDA)
3.0.0 - STU3 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: Plan of Treatment Section

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlanofTreatmentSection Version: 3.0.0
Draft as of 2024-05-18 Computable Name: PlanofTreatmentSection
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09

This section, formerly known as “Plan of Care”, contains data that define pending orders, interventions, encounters, services, and procedures for the patient. It is limited to prospective, unfulfilled, or incomplete orders and requests only. These are indicated by the @moodCode of the entries within this section. All active, incomplete, or pending orders, appointments, referrals, procedures, services, or any other pending event of clinical significance to the current care of the patient should be listed.

This section may also contain information about ongoing care of the patient, clinical reminders, patient’s values, beliefs, preferences, care expectations, and overarching care goals.

Clinical reminders are placed here to provide prompts for disease prevention and management, patient safety, and healthcare quality improvements, including widely accepted performance measures.

Values may include the importance of quality of life over longevity. These values are taken into account when prioritizing all problems and their treatments.

Beliefs may include comfort with dying or the refusal of blood transfusions because of the patient’s religious convictions.

Preferences may include liquid medicines over tablets, or treatment via secure email instead of in person.

Care expectations may range from being treated only by female clinicians, to expecting all calls to be returned within 24 hours.

Overarching goals described in this section are not tied to a specific condition, problem, health concern, or intervention. Examples of overarching goals could be to minimize pain or dependence on others, or to walk a daughter down the aisle for her marriage.

The plan may also indicate that patient education will be provided.

Usage:

Formal Views of Template Content

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

This structure is derived from Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.10
..... @extension 1..1 st Required Pattern: 2014-06-09
... code 1..1 CE Plan of care note
.... @code 1..1 cs Required Pattern: 18776-5
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation, profile:encounter, profile:procedure, profile:substanceAdministration, profile:supply
.... entry:plannedEnc 0..* Entry
..... encounter 1..1 PlannedEncounter Base for all types and resources
.... entry:plannedProc 0..* Entry
..... procedure 1..1 PlannedProcedure Base for all types and resources
.... entry:plannedMed 0..* Entry
..... substanceAdministration 1..1 PlannedMedicationActivity Base for all types and resources
.... entry:plannedSupply 0..* Entry
..... supply 1..1 PlannedSupply Base for all types and resources
.... entry:instruction 0..* Entry
..... act 1..1 Instruction Base for all types and resources
.... entry:handoffCommParticipants 0..* Entry
..... act 1..1 HandoffCommunicationParticipants Base for all types and resources
.... entry:nutrition 0..* Entry
..... act 1..1 NutritionRecommendation Base for all types and resources
.... entry:plannedImmunization 0..* Entry
..... substanceAdministration 1..1 PlannedImmunizationActivity Base for all types and resources
.... entry:goal 0..* Entry
..... observation 1..1 GoalObservation Base for all types and resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.10
..... @extension 1..1 st Required Pattern: 2014-06-09
... code 1..1 CE Plan of care note
Binding: DocumentSectionType (example)
.... @code 1..1 cs Required Pattern: 18776-5
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation, profile:encounter, profile:procedure, profile:substanceAdministration, profile:supply
.... entry:plannedEnc 0..* Entry
..... 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
.... entry:plannedProc 0..* Entry
..... 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
.... entry:plannedMed 0..* Entry
..... 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
.... entry:plannedSupply 0..* Entry
..... 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
.... entry:instruction 0..* Entry
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entry:handoffCommParticipants 0..* Entry
..... act C 1..1 HandoffCommunicationParticipants Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entry:nutrition 0..* Entry
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
.... entry:plannedImmunization 0..* Entry
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entry:goal 0..* Entry
..... observation C 1..1 GoalObservation 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

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorSection.entry:plannedMed.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorSection.entry:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:goal.observationSHOULD contain author
: author.exists()
should-codewarningSection.entry:plannedEnc.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedSupply.supply, Section.entry:nutrition.act, Section.entry:goal.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:instruction.act, Section.entry:handoffCommParticipants.act, Section.entry:nutrition.act, Section.entry:plannedImmunization.substanceAdministration, Section.entry:goal.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:section 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.10
..... @extension 1..1 st Required Pattern: 2014-06-09
... @ID 0..1 xs:ID
... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..1 II
... code 1..1 CE Plan of care note
Binding: DocumentSectionType (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: 18776-5
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... translation 0..* CD
... title 1..1 ST
... text 1..1 xhtml
... confidentialityCode 0..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... author 0..* Author
... informant 0..* Informant
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation, profile:encounter, profile:procedure, profile:substanceAdministration, profile:supply
.... entry:plannedEnc 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 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
.... entry:plannedProc 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 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
.... entry:plannedMed 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 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
.... entry:plannedSupply 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 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
.... entry:instruction 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... 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 0..1 Supply
.... entry:handoffCommParticipants 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act C 1..1 HandoffCommunicationParticipants Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... 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 0..1 Supply
.... entry:nutrition 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
..... 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 0..1 Supply
.... entry:plannedImmunization 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... supply 0..1 Supply
.... entry:goal 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation C 1..1 GoalObservation 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
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... component 0..* InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Fixed Value: COMP
.... @contextConductionInd 0..1 bl Fixed Value: true
.... section 1..1 Section

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorSection.entry:plannedMed.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorSection.entry:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:goal.observationSHOULD contain author
: author.exists()
should-codewarningSection.entry:plannedEnc.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedSupply.supply, Section.entry:nutrition.act, Section.entry:goal.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:instruction.act, Section.entry:handoffCommParticipants.act, Section.entry:nutrition.act, Section.entry:plannedImmunization.substanceAdministration, Section.entry:goal.observationSHOULD contain text/reference/@value
: text.reference.value.exists()

Differential View

This structure is derived from Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.10
..... @extension 1..1 st Required Pattern: 2014-06-09
... code 1..1 CE Plan of care note
.... @code 1..1 cs Required Pattern: 18776-5
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation, profile:encounter, profile:procedure, profile:substanceAdministration, profile:supply
.... entry:plannedEnc 0..* Entry
..... encounter 1..1 PlannedEncounter Base for all types and resources
.... entry:plannedProc 0..* Entry
..... procedure 1..1 PlannedProcedure Base for all types and resources
.... entry:plannedMed 0..* Entry
..... substanceAdministration 1..1 PlannedMedicationActivity Base for all types and resources
.... entry:plannedSupply 0..* Entry
..... supply 1..1 PlannedSupply Base for all types and resources
.... entry:instruction 0..* Entry
..... act 1..1 Instruction Base for all types and resources
.... entry:handoffCommParticipants 0..* Entry
..... act 1..1 HandoffCommunicationParticipants Base for all types and resources
.... entry:nutrition 0..* Entry
..... act 1..1 NutritionRecommendation Base for all types and resources
.... entry:plannedImmunization 0..* Entry
..... substanceAdministration 1..1 PlannedImmunizationActivity Base for all types and resources
.... entry:goal 0..* Entry
..... observation 1..1 GoalObservation Base for all types and resources

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:section 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.10
..... @extension 1..1 st Required Pattern: 2014-06-09
... code 1..1 CE Plan of care note
Binding: DocumentSectionType (example)
.... @code 1..1 cs Required Pattern: 18776-5
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... title 1..1 ST
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation, profile:encounter, profile:procedure, profile:substanceAdministration, profile:supply
.... entry:plannedEnc 0..* Entry
..... 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
.... entry:plannedProc 0..* Entry
..... 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
.... entry:plannedMed 0..* Entry
..... 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
.... entry:plannedSupply 0..* Entry
..... 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
.... entry:instruction 0..* Entry
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entry:handoffCommParticipants 0..* Entry
..... act C 1..1 HandoffCommunicationParticipants Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entry:nutrition 0..* Entry
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
.... entry:plannedImmunization 0..* Entry
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entry:goal 0..* Entry
..... observation C 1..1 GoalObservation 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

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorSection.entry:plannedMed.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorSection.entry:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:goal.observationSHOULD contain author
: author.exists()
should-codewarningSection.entry:plannedEnc.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedSupply.supply, Section.entry:nutrition.act, Section.entry:goal.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:instruction.act, Section.entry:handoffCommParticipants.act, Section.entry:nutrition.act, Section.entry:plannedImmunization.substanceAdministration, Section.entry:goal.observationSHOULD contain text/reference/@value
: text.reference.value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1 Section XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:section 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.10
..... @extension 1..1 st Required Pattern: 2014-06-09
... @ID 0..1 xs:ID
... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..1 II
... code 1..1 CE Plan of care note
Binding: DocumentSectionType (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: 18776-5
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... translation 0..* CD
... title 1..1 ST
... text 1..1 xhtml
... confidentialityCode 0..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... author 0..* Author
... informant 0..* Informant
... Slices for entry 0..* Entry Slice: Unordered, Open by profile:observation, profile:encounter, profile:procedure, profile:substanceAdministration, profile:supply
.... entry:plannedEnc 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 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
.... entry:plannedProc 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 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
.... entry:plannedMed 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 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
.... entry:plannedSupply 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 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
.... entry:instruction 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... 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 0..1 Supply
.... entry:handoffCommParticipants 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act C 1..1 HandoffCommunicationParticipants Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... 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 0..1 Supply
.... entry:nutrition 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
..... 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 0..1 Supply
.... entry:plannedImmunization 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... supply 0..1 Supply
.... entry:goal 0..* Entry
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation C 1..1 GoalObservation 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
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... component 0..* InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Fixed Value: COMP
.... @contextConductionInd 0..1 bl Fixed Value: true
.... section 1..1 Section

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dose-unit-or-admin-uniterrorSection.entry:plannedMed.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
shall-product-or-deviceerrorSection.entry:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:goal.observationSHOULD contain author
: author.exists()
should-codewarningSection.entry:plannedEnc.encounterSHOULD contain code
: code.exists()
should-effectiveTimewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedSupply.supply, Section.entry:nutrition.act, Section.entry:goal.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningSection.entry:plannedEnc.encounter, Section.entry:plannedProc.procedure, Section.entry:plannedMed.substanceAdministration, Section.entry:plannedSupply.supply, Section.entry:instruction.act, Section.entry:handoffCommParticipants.act, Section.entry:nutrition.act, Section.entry:plannedImmunization.substanceAdministration, Section.entry:goal.observationSHOULD contain text/reference/@value
: text.reference.value.exists()

 

Other representations of profile: CSV, Excel