Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Intervention Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/InterventionAct Version: 2.1
Draft as of 2023-09-29 Computable Name: InterventionAct
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.131:2015-08-01

This template represents an Intervention Act. It is a wrapper for 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 performed for a health concern of “respiratory insufficiency” 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.

Intervention Acts can be related to each other, or to Planned 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 an Intervention Act must have a moodCode of EVN, indicating that they have occurred.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.131
..... extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CD
.... code 1..1csRequired Pattern: 362956003
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CS
.... code 1..1csFixed Value: completed
... effectiveTime 0..1IVL_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply
.... 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:nutritionRecommendation 0..*EntryRelationship
..... act 1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReferenceRefr 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:entryReferenceRson C0..*EntryRelationshipAn Intervention Act should 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-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
..... typeCode 1..1csFixed Value: RSON
..... 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:plannedInterventionAct 0..*EntryRelationship
..... typeCode 1..1csFixed Value: REFR
..... act 1..1PlannedInterventionActBase 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

Constraints

IdGradePath(s)DetailsRequirements
1198-32459errorAct.entryRelationship:entryReferenceRsonThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.131
..... @extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 0..1IVL_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply
.... entryRelationship:advanceDirectiveObservation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1AdvanceDirectiveObservationBase for all types and resources
.... entryRelationship:immunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration 1..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 1..1InterventionActBase for all types and resources
.... entryRelationship:procedureActivityProcedure 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources
.... entryRelationship:encounterActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter 1..1EncounterActivityBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:nonMedSupply 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:nutritionRecommendation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
..... act 1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReferenceRefr 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 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryReferenceRson C0..*EntryRelationshipAn Intervention Act should 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-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:handoffCommunicationParticipants 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1HandoffCommunicationParticipantsBase for all types and resources
.... entryRelationship:plannedInterventionAct 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1PlannedInterventionActBase for all types and resources
... reference 0..*Reference
.... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.statusCoderequiredActStatus
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:nutritionRecommendation.typeCoderequiredXActRelationshipEntryRelationship
Act.entryRelationship:entryReferenceRefr.typeCoderequiredFixed Value: REFR
Act.entryRelationship:entryReferenceRson.typeCoderequiredFixed Value: RSON
Act.entryRelationship:handoffCommunicationParticipants.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedInterventionAct.typeCoderequiredFixed Value: REFR
Act.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-30800warningAct.entryRelationship:medicationActivity.substanceAdministrationMedication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800).
:
1198-32459errorAct.entryRelationship:entryReferenceRsonThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.131
..... @extension 1..1stRequired Pattern: 2015-08-01
... id 1..*II
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (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
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @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 (extensible)
... languageCode 0..1CSBinding: HumanLanguage (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 0..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply
.... entryRelationship:advanceDirectiveObservation 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..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: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..1ImmunizationActivityBase for all types and resources
..... supply 0..1Supply
.... entryRelationship:medicationActivity 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..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: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..1ProcedureActivityProcedureBase for all types and resources
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:encounterActivity 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..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: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..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: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:nutritionRecommendation 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..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:entryReferenceRefr 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: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..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:entryReferenceRson C0..*EntryRelationshipAn Intervention Act should 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-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..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: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..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:plannedInterventionAct 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... 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 1..1PlannedInterventionActBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... 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 1..1ExternalDocumentReferenceBase for all types and resources
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredNullFlavor
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.entryRelationship:advanceDirectiveObservation.nullFlavorrequiredNullFlavor
Act.entryRelationship:advanceDirectiveObservation.typeCoderequiredFixed Value: REFR
Act.entryRelationship:immunizationActivity.nullFlavorrequiredNullFlavor
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:medicationActivity.nullFlavorrequiredNullFlavor
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:interventionAct.nullFlavorrequiredNullFlavor
Act.entryRelationship:interventionAct.typeCoderequiredFixed Value: REFR
Act.entryRelationship:procedureActivityProcedure.nullFlavorrequiredNullFlavor
Act.entryRelationship:procedureActivityProcedure.typeCoderequiredFixed Value: REFR
Act.entryRelationship:encounterActivity.nullFlavorrequiredNullFlavor
Act.entryRelationship:encounterActivity.typeCoderequiredFixed Value: REFR
Act.entryRelationship:instruction.nullFlavorrequiredNullFlavor
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nonMedSupply.nullFlavorrequiredNullFlavor
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Act.entryRelationship:nutritionRecommendation.nullFlavorrequiredNullFlavor
Act.entryRelationship:nutritionRecommendation.typeCoderequiredXActRelationshipEntryRelationship
Act.entryRelationship:entryReferenceRefr.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryReferenceRefr.typeCoderequiredFixed Value: REFR
Act.entryRelationship:entryReferenceRson.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryReferenceRson.typeCoderequiredFixed Value: RSON
Act.entryRelationship:handoffCommunicationParticipants.nullFlavorrequiredNullFlavor
Act.entryRelationship:handoffCommunicationParticipants.typeCoderequiredFixed Value: REFR
Act.entryRelationship:plannedInterventionAct.nullFlavorrequiredNullFlavor
Act.entryRelationship:plannedInterventionAct.typeCoderequiredFixed Value: REFR
Act.reference.nullFlavorrequiredNullFlavor
Act.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-30800warningAct.entryRelationship:medicationActivity.substanceAdministrationMedication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800).
:
1198-32459errorAct.entryRelationship:entryReferenceRsonThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 9 elements (14 nested mandatory elements)
Fixed Value: 16 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

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.131
..... extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CD
.... code 1..1csRequired Pattern: 362956003
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CS
.... code 1..1csFixed Value: completed
... effectiveTime 0..1IVL_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply
.... 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:nutritionRecommendation 0..*EntryRelationship
..... act 1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReferenceRefr 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:entryReferenceRson C0..*EntryRelationshipAn Intervention Act should 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-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
..... typeCode 1..1csFixed Value: RSON
..... 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:plannedInterventionAct 0..*EntryRelationship
..... typeCode 1..1csFixed Value: REFR
..... act 1..1PlannedInterventionActBase 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

Constraints

IdGradePath(s)DetailsRequirements
1198-32459errorAct.entryRelationship:entryReferenceRsonThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.131
..... @extension 1..1stRequired Pattern: 2015-08-01
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @code 1..1csRequired Pattern: 362956003
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 0..1IVL_TS
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply
.... entryRelationship:advanceDirectiveObservation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1AdvanceDirectiveObservationBase for all types and resources
.... entryRelationship:immunizationActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration 1..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 1..1InterventionActBase for all types and resources
.... entryRelationship:procedureActivityProcedure 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources
.... entryRelationship:encounterActivity 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter 1..1EncounterActivityBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:nonMedSupply 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:nutritionRecommendation 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
..... act 1..1NutritionRecommendationBase for all types and resources
.... entryRelationship:entryReferenceRefr 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 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryReferenceRson C0..*EntryRelationshipAn Intervention Act should 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-32459: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1198-32459).