This page is part of the CCDA: Consolidated CDA Release (v4.0.0-ballot: CCDA 4.0 Ballot 1) generated with FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/InterventionAct | Version: 4.0.0-ballot | |||
Draft as of 2024-12-20 | Computable Name: InterventionAct | |||
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Act
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Act | XML 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 Instance 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 |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.131 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2015-08-01 | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: ACT | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: 362956003 | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
![]() ![]() ![]() |
1..1 | CS | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
0..1 | IVL_TS | ||
![]() ![]() ![]() |
0..* | AuthorParticipation | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode, profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply | |
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AdvanceDirectiveObservation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ImmunizationActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicationActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | The following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention). | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | InterventionAct | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ProcedureActivityProcedure | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EncounterActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | InstructionObservation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | NonMedicinalSupplyActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | NutritionRecommendation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | 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. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EntryReference | ||
![]() ![]() ![]() ![]() |
C | 0..* | EntryRelationship | An 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. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: RSON | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EntryReference | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | HandoffCommunicationParticipants | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | PlannedInterventionAct | ||
![]() ![]() ![]() |
0..* | Reference | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() |
1..1 | ExternalDocumentReference | ||
![]() |
Id | Grade | Path(s) | Details | Requirements |
entry-ref-goal | error | Act.entryRelationship:entryReferenceRson | This 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-author | warning | Act | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Path | Conformance | ValueSet / Code | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:intervention-act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Act.entryRelationship:advanceDirectiveObservation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:immunizationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:medicationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:interventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:procedureActivityProcedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:encounterActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:instruction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nutritionRecommendation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRefr.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:handoffCommunicationParticipants.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:plannedInterventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId, Act.entryRelationship:advanceDirectiveObservation.typeId, Act.entryRelationship:immunizationActivity.typeId, Act.entryRelationship:medicationActivity.typeId, Act.entryRelationship:interventionAct.typeId, Act.entryRelationship:procedureActivityProcedure.typeId, Act.entryRelationship:encounterActivity.typeId, Act.entryRelationship:instruction.typeId, Act.entryRelationship:nonMedSupply.typeId, Act.entryRelationship:nutritionRecommendation.typeId, Act.entryRelationship:entryReferenceRefr.typeId, Act.entryRelationship:entryReferenceRson.typeId, Act.entryRelationship:handoffCommunicationParticipants.typeId, Act.entryRelationship:plannedInterventionAct.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
entry-ref-goal | error | Act.entryRelationship:entryReferenceRson | This 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-author | warning | Act | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Path | Conformance | ValueSet / Code | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:intervention-act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Act.entryRelationship:advanceDirectiveObservation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:immunizationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:medicationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:interventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:procedureActivityProcedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:encounterActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:instruction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nutritionRecommendation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRefr.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:handoffCommunicationParticipants.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:plannedInterventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId, Act.entryRelationship:advanceDirectiveObservation.typeId, Act.entryRelationship:immunizationActivity.typeId, Act.entryRelationship:medicationActivity.typeId, Act.entryRelationship:interventionAct.typeId, Act.entryRelationship:procedureActivityProcedure.typeId, Act.entryRelationship:encounterActivity.typeId, Act.entryRelationship:instruction.typeId, Act.entryRelationship:nonMedSupply.typeId, Act.entryRelationship:nutritionRecommendation.typeId, Act.entryRelationship:entryReferenceRefr.typeId, Act.entryRelationship:entryReferenceRson.typeId, Act.entryRelationship:handoffCommunicationParticipants.typeId, Act.entryRelationship:plannedInterventionAct.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
entry-ref-goal | error | Act.entryRelationship:entryReferenceRson | This 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-author | warning | Act | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If 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: 9 elements(14 nested mandatory elements)
Fixed: 17 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Act
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Act | XML 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 Instance 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 |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.131 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2015-08-01 | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: ACT | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: 362956003 | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
![]() ![]() ![]() |
1..1 | CS | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
0..1 | IVL_TS | ||
![]() ![]() ![]() |
0..* | AuthorParticipation | ||
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by value:typeCode, profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply | |
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AdvanceDirectiveObservation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ImmunizationActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicationActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | The following entryRelationship represents the relationship between two Intervention Acts (Intervention RELATES TO Intervention). | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | InterventionAct | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ProcedureActivityProcedure | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EncounterActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | InstructionObservation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | NonMedicinalSupplyActivity | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | NutritionRecommendation | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | 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. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EntryReference | ||
![]() ![]() ![]() ![]() |
C | 0..* | EntryRelationship | An 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. entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: RSON | |
![]() ![]() ![]() ![]() ![]() |
1..1 | EntryReference | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | HandoffCommunicationParticipants | ||
![]() ![]() ![]() ![]() |
0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | PlannedInterventionAct | ||
![]() ![]() ![]() |
0..* | Reference | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() |
1..1 | ExternalDocumentReference | ||
![]() |
Id | Grade | Path(s) | Details | Requirements |
entry-ref-goal | error | Act.entryRelationship:entryReferenceRson | This 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-author | warning | Act | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
Path | Conformance | ValueSet / Code | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:intervention-act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Act.entryRelationship:advanceDirectiveObservation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:immunizationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:medicationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:interventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:procedureActivityProcedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:encounterActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:instruction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nutritionRecommendation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRefr.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:handoffCommunicationParticipants.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:plannedInterventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId, Act.entryRelationship:advanceDirectiveObservation.typeId, Act.entryRelationship:immunizationActivity.typeId, Act.entryRelationship:medicationActivity.typeId, Act.entryRelationship:interventionAct.typeId, Act.entryRelationship:procedureActivityProcedure.typeId, Act.entryRelationship:encounterActivity.typeId, Act.entryRelationship:instruction.typeId, Act.entryRelationship:nonMedSupply.typeId, Act.entryRelationship:nutritionRecommendation.typeId, Act.entryRelationship:entryReferenceRefr.typeId, Act.entryRelationship:entryReferenceRson.typeId, Act.entryRelationship:handoffCommunicationParticipants.typeId, Act.entryRelationship:plannedInterventionAct.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
entry-ref-goal | error | Act.entryRelationship:entryReferenceRson | This 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-author | warning | Act | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:intervention-act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Act.entryRelationship:advanceDirectiveObservation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:advanceDirectiveObservation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:immunizationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:immunizationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:medicationActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:medicationActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:interventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:interventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:procedureActivityProcedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:procedureActivityProcedure.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:encounterActivity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:encounterActivity.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:instruction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:instruction.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:nutritionRecommendation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:nutritionRecommendation.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRefr.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRefr.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:entryReferenceRson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:entryReferenceRson.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:handoffCommunicationParticipants.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:handoffCommunicationParticipants.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.entryRelationship:plannedInterventionAct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.entryRelationship:plannedInterventionAct.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Act.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.reference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId, Act.entryRelationship:advanceDirectiveObservation.typeId, Act.entryRelationship:immunizationActivity.typeId, Act.entryRelationship:medicationActivity.typeId, Act.entryRelationship:interventionAct.typeId, Act.entryRelationship:procedureActivityProcedure.typeId, Act.entryRelationship:encounterActivity.typeId, Act.entryRelationship:instruction.typeId, Act.entryRelationship:nonMedSupply.typeId, Act.entryRelationship:nutritionRecommendation.typeId, Act.entryRelationship:entryReferenceRefr.typeId, Act.entryRelationship:entryReferenceRson.typeId, Act.entryRelationship:handoffCommunicationParticipants.typeId, Act.entryRelationship:plannedInterventionAct.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
entry-ref-goal | error | Act.entryRelationship:entryReferenceRson | This 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-author | warning | Act | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If 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: 9 elements(14 nested mandatory elements)
Fixed: 17 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: