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: Planned Intervention Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedInterventionAct Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: PlannedInterventionAct
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.146:2015-08-01

This template represents a Planned Intervention Act. It is a wrapper for planned intervention-type activities considered to be parts of the same intervention. For example, an activity such as “elevate head of bed” combined with “provide humidified O2 per nasal cannula” may be the interventions planned for a health concern of “respiratory insufficiency” in order to attempt to achieve a goal of “pulse oximetry greater than 92%”. These intervention activities may be newly described or derived from a variety of sources within an EHR.

Interventions are actions taken to increase the likelihood of achieving the patient’s or providers’ goals. An Intervention Act should contain a reference to a Goal Observation representing the reason for the intervention.

Planned Intervention Acts can be related to each other or to Intervention Acts. (E.g., a Planned Intervention Act with moodCode of INT could be related to a series of Intervention Acts with moodCode of EVN, each having an effectiveTime containing the time of the intervention.)

All interventions referenced in a Planned Intervention Act must have moodCodes indicating that that are planned (have not yet occurred).

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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1stRequired Pattern: 2015-08-01
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csBinding: Planned Intervention moodCode (required)
... code 1..1CD
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... 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_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C1..*EntryRelationshipAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1csFixed Value: RSON
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:advanceDirectiveObservation 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1AdvanceDirectiveObservationBase for all types and resources
.... entryRelationship:immunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1ImmunizationActivityBase for all types and resources
.... entryRelationship:medicationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1MedicationActivityBase for all types and resources
.... entryRelationship:interventionAct 0..*EntryRelationshipThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1InterventionActBase for all types and resources
.... entryRelationship:procedureActivityProcedure 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources
.... entryRelationship:encounterActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... encounter 1..1EncounterActivityBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:nonMedSupply 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1PlannedActBase for all types and resources
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... encounter 1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedObservation 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProcedure 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... procedure 1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedMedicationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1PlannedMedicationActivityBase for all types and resources
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1PlannedSupplyBase for all types and resources
.... entryRelationship:nutritionRecommendation 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReference 0..*EntryRelationshipWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:handoffCommunicationParticipants 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1HandoffCommunicationParticipantsBase for all types and resources
.... entryRelationship:plannedImmunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1PlannedImmunizationActivityBase for all types and resources
... reference 0..*Reference
.... @typeCode 1..1csFixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPlannedInterventionMoodCode

Constraints

IdGradePath(s)DetailsRequirements
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
should-authorwarningActSHOULD contain author
: author.exists()
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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1stRequired Pattern: 2015-08-01
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned Intervention moodCode (required)
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... 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_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C1..*EntryRelationshipAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... act C1..1EntryReferenceBase for all types and resources
.... entryRelationship:advanceDirectiveObservation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1AdvanceDirectiveObservationBase for all types and resources
.... entryRelationship:immunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1ImmunizationActivityBase for all types and resources
.... entryRelationship:medicationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1MedicationActivityBase for all types and resources
.... entryRelationship:interventionAct 0..*EntryRelationshipThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1InterventionActBase for all types and resources
.... entryRelationship:procedureActivityProcedure 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C1..1ProcedureActivityProcedureBase for all types and resources
.... entryRelationship:encounterActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C1..1EncounterActivityBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1InstructionBase for all types and resources
.... entryRelationship:nonMedSupply 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1NonMedicinalSupplyActivityBase 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
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedObservation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProcedure 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedMedicationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1PlannedMedicationActivityBase 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:nutritionRecommendation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReference 0..*EntryRelationshipWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1EntryReferenceBase for all types and resources
.... entryRelationship:handoffCommunicationParticipants 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1HandoffCommunicationParticipantsBase for all types and resources
.... entryRelationship:plannedImmunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1PlannedImmunizationActivityBase for all types and resources
... reference 0..*Reference
.... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... externalDocument C1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedInterventionMoodCode
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
Act.entryRelationship:advanceDirectiveObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:interventionAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:procedureActivityProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:encounterActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:handoffCommunicationParticipants.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
Act.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
active-high-ts-after-documenterrorAct.entryRelationship:procedureActivityProcedure.procedureIf the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime
: (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
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-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:interventionAct.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-informantwarningAct.entryRelationship:advanceDirectiveObservation.observationSHOULD contain informant
: informant.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:procedureActivityProcedure.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-targetSiteCodewarningAct.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedObservation.observationSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:encounterActivity.encounter, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:handoffCommunicationParticipants.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.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
should-author: SHOULD contain author
... @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:planned-intervention-act 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.146
..... @extension 1..1stRequired Pattern: 2015-08-01
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned Intervention moodCode (required)
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @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)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... 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_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C1..*EntryRelationshipAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @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: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1EntryReferenceBase 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
.... entryRelationship:advanceDirectiveObservation 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..1AdvanceDirectiveObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:immunizationActivity 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..1ImmunizationActivityBase for all types and resources
..... supply 0..1Supply
.... entryRelationship:medicationActivity 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..1MedicationActivityBase for all types and resources
..... supply 0..1Supply
.... entryRelationship:interventionAct 0..*EntryRelationshipThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
..... @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..1InterventionActBase 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
.... entryRelationship:procedureActivityProcedure 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..1ProcedureActivityProcedureBase for all types and resources
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:encounterActivity 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..1EncounterActivityBase 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:instruction 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..1InstructionBase 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
.... entryRelationship:nonMedSupply 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..1NonMedicinalSupplyActivityBase 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
.... 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:plannedObservation 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:plannedProcedure 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:plannedMedicationActivity 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: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:nutritionRecommendation 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..1NutritionRecommendationBase 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
.... entryRelationship:entryReference 0..*EntryRelationshipWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
..... @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..1EntryReferenceBase 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
.... entryRelationship:handoffCommunicationParticipants 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..1HandoffCommunicationParticipantsBase 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
.... entryRelationship:plannedImmunizationActivity 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..1PlannedImmunizationActivityBase for all types and resources
..... supply 0..1Supply
... reference 0..*Reference
.... @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_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument C1..1ExternalDocumentReferenceBase for all types and resources
... 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:planned-intervention-act.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedInterventionMoodCode
Act.codeexampleActCode
Act.code.nullFlavorrequiredCDANullFlavor
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:reason.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:reason.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
Act.entryRelationship:advanceDirectiveObservation.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:advanceDirectiveObservation.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:advanceDirectiveObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:immunizationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:immunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:medicationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:medicationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:interventionAct.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:interventionAct.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:interventionAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:procedureActivityProcedure.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:procedureActivityProcedure.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:procedureActivityProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:encounterActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:encounterActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:encounterActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nonMedSupply.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nonMedSupply.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObservation.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObservation.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProcedure.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProcedure.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedicationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nutritionRecommendation.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:entryReference.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryReference.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:handoffCommunicationParticipants.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:handoffCommunicationParticipants.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:handoffCommunicationParticipants.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedImmunizationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
Act.reference.nullFlavorrequiredCDANullFlavor
Act.reference.typeId.nullFlavorrequiredCDANullFlavor
Act.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
active-high-ts-after-documenterrorAct.entryRelationship:procedureActivityProcedure.procedureIf the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime
: (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
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-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:interventionAct.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-informantwarningAct.entryRelationship:advanceDirectiveObservation.observationSHOULD contain informant
: informant.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:procedureActivityProcedure.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-targetSiteCodewarningAct.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedObservation.observationSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:encounterActivity.encounter, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:handoffCommunicationParticipants.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.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: 12 elements (19 nested mandatory elements)
Fixed Value: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1stRequired Pattern: 2015-08-01
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csBinding: Planned Intervention moodCode (required)
... code 1..1CD
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... 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_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C1..*EntryRelationshipAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1csFixed Value: RSON
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:advanceDirectiveObservation 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1AdvanceDirectiveObservationBase for all types and resources
.... entryRelationship:immunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1ImmunizationActivityBase for all types and resources
.... entryRelationship:medicationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1MedicationActivityBase for all types and resources
.... entryRelationship:interventionAct 0..*EntryRelationshipThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1InterventionActBase for all types and resources
.... entryRelationship:procedureActivityProcedure 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources
.... entryRelationship:encounterActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... encounter 1..1EncounterActivityBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:nonMedSupply 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:plannedAct 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1PlannedActBase for all types and resources
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... encounter 1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedObservation 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProcedure 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... procedure 1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedMedicationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1PlannedMedicationActivityBase for all types and resources
.... entryRelationship:plannedSupply 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1PlannedSupplyBase for all types and resources
.... entryRelationship:nutritionRecommendation 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReference 0..*EntryRelationshipWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:handoffCommunicationParticipants 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... act 1..1HandoffCommunicationParticipantsBase for all types and resources
.... entryRelationship:plannedImmunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... substanceAdministration 1..1PlannedImmunizationActivityBase for all types and resources
... reference 0..*Reference
.... @typeCode 1..1csFixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPlannedInterventionMoodCode

Constraints

IdGradePath(s)DetailsRequirements
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
should-authorwarningActSHOULD contain author
: author.exists()
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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1stRequired Pattern: 2015-08-01
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned Intervention moodCode (required)
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... 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_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C1..*EntryRelationshipAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... act C1..1EntryReferenceBase for all types and resources
.... entryRelationship:advanceDirectiveObservation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1AdvanceDirectiveObservationBase for all types and resources
.... entryRelationship:immunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1ImmunizationActivityBase for all types and resources
.... entryRelationship:medicationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1MedicationActivityBase for all types and resources
.... entryRelationship:interventionAct 0..*EntryRelationshipThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1InterventionActBase for all types and resources
.... entryRelationship:procedureActivityProcedure 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C1..1ProcedureActivityProcedureBase for all types and resources
.... entryRelationship:encounterActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C1..1EncounterActivityBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1InstructionBase for all types and resources
.... entryRelationship:nonMedSupply 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1NonMedicinalSupplyActivityBase 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
.... entryRelationship:plannedEncounter 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C1..1PlannedEncounterBase for all types and resources
.... entryRelationship:plannedObservation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1PlannedObservationBase for all types and resources
.... entryRelationship:plannedProcedure 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C1..1PlannedProcedureBase for all types and resources
.... entryRelationship:plannedMedicationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1PlannedMedicationActivityBase 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:nutritionRecommendation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReference 0..*EntryRelationshipWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1EntryReferenceBase for all types and resources
.... entryRelationship:handoffCommunicationParticipants 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C1..1HandoffCommunicationParticipantsBase for all types and resources
.... entryRelationship:plannedImmunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C1..1PlannedImmunizationActivityBase for all types and resources
... reference 0..*Reference
.... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... externalDocument C1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedInterventionMoodCode
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
Act.entryRelationship:advanceDirectiveObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:interventionAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:procedureActivityProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:encounterActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:handoffCommunicationParticipants.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
Act.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
active-high-ts-after-documenterrorAct.entryRelationship:procedureActivityProcedure.procedureIf the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime
: (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
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-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:interventionAct.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-informantwarningAct.entryRelationship:advanceDirectiveObservation.observationSHOULD contain informant
: informant.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:procedureActivityProcedure.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-targetSiteCodewarningAct.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedObservation.observationSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:encounterActivity.encounter, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:handoffCommunicationParticipants.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.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
should-author: SHOULD contain author
... @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:planned-intervention-act 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.146
..... @extension 1..1stRequired Pattern: 2015-08-01
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned Intervention moodCode (required)
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @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)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... 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_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C1..*EntryRelationshipAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @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: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1EntryReferenceBase 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
.... entryRelationship:advanceDirectiveObservation 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..1AdvanceDirectiveObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:immunizationActivity 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..1ImmunizationActivityBase for all types and resources
..... supply 0..1Supply
.... entryRelationship:medicationActivity 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..1MedicationActivityBase for all types and resources
..... supply 0..1Supply
.... entryRelationship:interventionAct 0..*EntryRelationshipThe following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention).
..... @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..1InterventionActBase 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
.... entryRelationship:procedureActivityProcedure 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..1ProcedureActivityProcedureBase for all types and resources
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:encounterActivity 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..1EncounterActivityBase 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:instruction 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..1InstructionBase 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
.... entryRelationship:nonMedSupply 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..1NonMedicinalSupplyActivityBase 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
.... 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:plannedObservation 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:plannedProcedure 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:plannedMedicationActivity 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: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:nutritionRecommendation 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..1NutritionRecommendationBase 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
.... entryRelationship:entryReference 0..*EntryRelationshipWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
..... @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..1EntryReferenceBase 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
.... entryRelationship:handoffCommunicationParticipants 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..1HandoffCommunicationParticipantsBase 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
.... entryRelationship:plannedImmunizationActivity 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..1PlannedImmunizationActivityBase for all types and resources
..... supply 0..1Supply
... reference 0..*Reference
.... @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_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument C1..1ExternalDocumentReferenceBase for all types and resources
... 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:planned-intervention-act.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedInterventionMoodCode
Act.codeexampleActCode
Act.code.nullFlavorrequiredCDANullFlavor
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:reason.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:reason.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
Act.entryRelationship:advanceDirectiveObservation.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:advanceDirectiveObservation.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:advanceDirectiveObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:immunizationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:immunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:medicationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:medicationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:interventionAct.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:interventionAct.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:interventionAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:procedureActivityProcedure.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:procedureActivityProcedure.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:procedureActivityProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:encounterActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:encounterActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:encounterActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nonMedSupply.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nonMedSupply.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedAct.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedObservation.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObservation.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedProcedure.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProcedure.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedMedicationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nutritionRecommendation.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:entryReference.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryReference.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:handoffCommunicationParticipants.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:handoffCommunicationParticipants.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:handoffCommunicationParticipants.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedImmunizationActivity.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
Act.reference.nullFlavorrequiredCDANullFlavor
Act.reference.typeId.nullFlavorrequiredCDANullFlavor
Act.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
active-high-ts-after-documenterrorAct.entryRelationship:procedureActivityProcedure.procedureIf the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime
: (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
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-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:interventionAct.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-informantwarningAct.entryRelationship:advanceDirectiveObservation.observationSHOULD contain informant
: informant.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:procedureActivityProcedure.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-targetSiteCodewarningAct.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:plannedObservation.observationSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:advanceDirectiveObservation.observation, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:interventionAct.act, Act.entryRelationship:procedureActivityProcedure.procedure, Act.entryRelationship:encounterActivity.encounter, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedAct.act, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedObservation.observation, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:handoffCommunicationParticipants.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.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: 12 elements (19 nested mandatory elements)
Fixed Value: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel