Consolidated CDA Release 2.2
2.2 - CI Build
Consolidated CDA Release 2.2
2.2 - CI Build
Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.146 | Version: 2.2 | |||
| Active as of 2022-05-13 | Computable Name: PlannedInterventionAct | |||
| Other Identifiers: : 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Act
Summary
Mandatory: 14 elements (41 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Act | 1..1 | CDAR2.Act | ||
 classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned Intervention moodCode (required) | |
  Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary | 1..1 | II | ||
  root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.146 | |
  extension | 1..1 | string | Required Pattern: 2015-08-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | string | Required Pattern: 362956003 | |
 codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.6.96 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | string | Required Pattern: active | |
| effectiveTime | 0..1 | IVL_TS | ||
 author | 0..* | AuthorParticipation | ||
| Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply | |
 entryRelationship:advanceDirectiveObservation | 0..* | Element | ||
 typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | AdvanceDirectiveObservation | ||
| entryRelationship:immunizationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | ImmunizationActivity | ||
| entryRelationship:medicationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | MedicationActivity | ||
| entryRelationship:procedureActivityAct | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | ProcedureActivityAct | ||
| entryRelationship:interventionAct | 0..* | Element | The following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention). | |
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | InterventionAct | ||
| entryRelationship:procedureActivityObservation | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | ProcedureActivityObservation | ||
| entryRelationship:procedureActivityProcedure | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| procedure | 1..1 | ProcedureActivityProcedure | ||
| entryRelationship:encounterActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| encounter | 1..1 | EncounterActivity | ||
| entryRelationship:instruction | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | Instruction | ||
| entryRelationship:entryRelationship10 | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| supply | 1..1 | NonMedicinalSupplyActivity | ||
| entryRelationship:plannedAct | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | PlannedAct | ||
| entryRelationship:plannedEncounter | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| encounter | 1..1 | PlannedEncounter | ||
| entryRelationship:plannedObservation | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | PlannedObservation | ||
| entryRelationship:plannedProcedure | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| procedure | 1..1 | PlannedProcedure | ||
| entryRelationship:plannedMedicationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | PlannedMedicationActivity | ||
| entryRelationship:entryRelationship16 | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| supply | 1..1 | PlannedSupply | ||
| entryRelationship:nutritionRecommendation | 0..* | Element | ||
| act | 1..1 | NutritionRecommendation | ||
| entryRelationship:entryReference | 0..* | Element | Where 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..1 | code | Required Pattern: REFR | |
| act | 1..1 | EntryReference | ||
| entryRelationship:entryReference | I | 1..* | Element | An 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. 1198-32722: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32722). |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| act | 1..1 | EntryReference | ||
| entryRelationship:handoffCommunicationParticipants | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | HandoffCommunicationParticipants | ||
| entryRelationship:plannedImmunizationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | PlannedImmunizationActivity | ||
 reference | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| externalDocument | 1..1 | ExternalDocumentReference | ||
| Documentation for this format | ||||
This structure is derived from CDAR2.Act
Summary
Mandatory: 14 elements (41 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | ||
| classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned Intervention moodCode (required) | |
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.146 | |
| extension | 1..1 | string | Required Pattern: 2015-08-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | string | Required Pattern: 362956003 | |
| codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.6.96 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | string | Required Pattern: active | |
| effectiveTime | 0..1 | IVL_TS | ||
| author | 0..* | AuthorParticipation | ||
| Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply | |
| entryRelationship:advanceDirectiveObservation | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | AdvanceDirectiveObservation | ||
| entryRelationship:immunizationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | ImmunizationActivity | ||
| entryRelationship:medicationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | MedicationActivity | ||
| entryRelationship:procedureActivityAct | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | ProcedureActivityAct | ||
| entryRelationship:interventionAct | 0..* | Element | The following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention). | |
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | InterventionAct | ||
| entryRelationship:procedureActivityObservation | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | ProcedureActivityObservation | ||
| entryRelationship:procedureActivityProcedure | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| procedure | 1..1 | ProcedureActivityProcedure | ||
| entryRelationship:encounterActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| encounter | 1..1 | EncounterActivity | ||
| entryRelationship:instruction | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | Instruction | ||
| entryRelationship:entryRelationship10 | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| supply | 1..1 | NonMedicinalSupplyActivity | ||
| entryRelationship:plannedAct | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | PlannedAct | ||
| entryRelationship:plannedEncounter | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| encounter | 1..1 | PlannedEncounter | ||
| entryRelationship:plannedObservation | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | PlannedObservation | ||
| entryRelationship:plannedProcedure | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| procedure | 1..1 | PlannedProcedure | ||
| entryRelationship:plannedMedicationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | PlannedMedicationActivity | ||
| entryRelationship:entryRelationship16 | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| supply | 1..1 | PlannedSupply | ||
| entryRelationship:nutritionRecommendation | 0..* | Element | ||
| act | 1..1 | NutritionRecommendation | ||
| entryRelationship:entryReference | 0..* | Element | Where 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..1 | code | Required Pattern: REFR | |
| act | 1..1 | EntryReference | ||
| entryRelationship:entryReference | I | 1..* | Element | An 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. 1198-32722: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32722). |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| act | 1..1 | EntryReference | ||
| entryRelationship:handoffCommunicationParticipants | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| act | 1..1 | HandoffCommunicationParticipants | ||
| entryRelationship:plannedImmunizationActivity | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| substanceAdministration | 1..1 | PlannedImmunizationActivity | ||
| reference | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: REFR | |
| externalDocument | 1..1 | ExternalDocumentReference | ||
| Documentation for this format | ||||
Snapshot View
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Act.moodCode | required | Planned Intervention moodCode |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| Act.code.nullFlavor | required | NullFlavor |
| Act.statusCode | required | ActStatus |
| Act.statusCode.nullFlavor | required | NullFlavor |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage |
| Act.subject.typeCode | required | Fixed Value: SBJ |
| Act.subject.contextControlCode | required | Fixed Value: OP |
| Act.subject.awarenessCode | extensible | TargetAwareness |
| Act.informant.typeCode | required | Fixed Value: INF |
| Act.informant.contextControlCode | required | Fixed Value: OP |
| Id | Grade | Path | Details | Requirements |
| act-er-1 | error | Act.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:advanceDirectiveObservation | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:immunizationActivity | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:medicationActivity | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| 1098-30800 | warning | Act.entryRelationship:medicationActivity.substanceAdministration | Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). : | |
| act-er-1 | error | Act.entryRelationship:procedureActivityAct | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:interventionAct | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:procedureActivityObservation | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:procedureActivityProcedure | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:encounterActivity | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:entryRelationship10 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:plannedAct | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:plannedEncounter | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:plannedObservation | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:plannedProcedure | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:plannedMedicationActivity | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:entryRelationship16 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:nutritionRecommendation | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:entryReference | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| 1198-32722 | error | Act.entryRelationship:entryReference | This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32722). : | |
| act-er-1 | error | Act.entryRelationship:entryReference | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| 1198-32722 | error | Act.entryRelationship:entryReference | This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32722). : | |
| act-er-1 | error | Act.entryRelationship:handoffCommunicationParticipants | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| act-er-1 | error | Act.entryRelationship:plannedImmunizationActivity | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccdar2dot2#2.2 based on FHIR 4.0.1. Generated 2022-05-13
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change
(Choice of one)