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

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: Planned Intervention Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedInterventionAct Version: 3.0.0
Draft as of 2024-05-18 Computable Name: PlannedInterventionAct
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.146:2015-08-01

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

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

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

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

Usage:

Formal Views of Template Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1 st Required Pattern: 2015-08-01
... @classCode 1..1 cs Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned Intervention moodCode . (required)
... code 1..1 CD
.... @code 1..1 cs Required Pattern: 362956003
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS
... author 0..* AuthorParticipation Base for all types and resources
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C 1..* EntryRelationship An Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1 cs Fixed Value: RSON
..... act 1..1 EntryReference Base for all types and resources
.... entryRelationship:immunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 ImmunizationActivity Base for all types and resources
.... entryRelationship:medicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 MedicationActivity Base for all types and resources
.... entryRelationship:instruction 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... act 1..1 Instruction Base for all types and resources
.... entryRelationship:nonMedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... supply 1..1 NonMedicinalSupplyActivity Base for all types and resources
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... encounter 1..1 PlannedEncounter Base for all types and resources
.... entryRelationship:plannedProcedure 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... procedure 1..1 PlannedProcedure Base for all types and resources
.... entryRelationship:plannedMedicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 PlannedMedicationActivity Base for all types and resources
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... supply 1..1 PlannedSupply Base for all types and resources
.... entryRelationship:nutritionRecommendation 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... act 1..1 NutritionRecommendation Base for all types and resources
.... entryRelationship:entryReference 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.
..... @typeCode 1..1 cs Fixed Value: REFR
..... act 1..1 EntryReference Base for all types and resources
.... entryRelationship:plannedImmunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 PlannedImmunizationActivity Base for all types and resources
... reference 0..* Reference
.... @typeCode 1..1 cs Fixed Value: REFR
.... externalDocument 1..1 ExternalDocumentReference Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.moodCoderequiredPlannedInterventionMoodCode .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54

Constraints

IdGradePath(s)DetailsRequirements
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
should-authorwarningActSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1 st Required Pattern: 2015-08-01
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned Intervention moodCode . (required)
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @code 1..1 cs Required Pattern: 362956003
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS
... author 0..* AuthorParticipation Base for all types and resources
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C 1..* EntryRelationship An Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entryRelationship:immunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 ImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-doseQuantity: SHOULD contain doseQuantity
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-performer: SHOULD contain performer
should-author: SHOULD contain author
.... entryRelationship:medicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 MedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
should-routeCode: SHOULD contain routeCode
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
.... entryRelationship:instruction 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entryRelationship:nonMedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C 1..1 NonMedicinalSupplyActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedProcedure 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedMedicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author
.... entryRelationship:nutritionRecommendation 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
.... entryRelationship:entryReference 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.
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entryRelationship:plannedImmunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
... reference 0..* Reference
.... @typeCode 1..1 cs Binding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... externalDocument C 1..1 ExternalDocumentReference Base for all types and resources
should-setId: SHOULD contain setId
should-versionNumber: SHOULD contain versionNumber

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedInterventionMoodCode .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.reference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 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
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:planned-intervention-act 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1 st Required Pattern: 2015-08-01
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned Intervention moodCode . (required)
... @negationInd 0..1 bl
... id 1..* II
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: 362956003
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* AuthorParticipation Base for all types and resources
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C 1..* EntryRelationship An Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:immunizationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 ImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-doseQuantity: SHOULD contain doseQuantity
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-performer: SHOULD contain performer
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:medicationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 MedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
should-routeCode: SHOULD contain routeCode
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:instruction 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:nonMedSupply 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply C 1..1 NonMedicinalSupplyActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedProcedure 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedMedicationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author
.... entryRelationship:nutritionRecommendation 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:entryReference 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.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedImmunizationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... supply 0..1 Supply
... reference 0..* Reference
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 1..1 cs Binding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... seperatableInd 0..1 BL
.... externalAct 0..1 ExternalAct
.... externalObservation 0..1 ExternalObservation
.... externalProcedure 0..1 ExternalProcedure
.... externalDocument C 1..1 ExternalDocumentReference Base for all types and resources
should-setId: SHOULD contain setId
should-versionNumber: SHOULD contain versionNumber
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:planned-intervention-act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedInterventionMoodCode .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Act.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Act.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Act.entryRelationship:reason.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:reason.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:immunizationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:immunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:medicationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:medicationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nonMedSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nonMedSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProcedure.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProcedure.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedicationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nutritionRecommendation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:entryReference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryReference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedImmunizationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.reference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.reference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 12 elements(12 nested mandatory elements)
Fixed: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Act.templateId
  • The element 7 is sliced based on the values of Act.entryRelationship

Differential View

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1 st Required Pattern: 2015-08-01
... @classCode 1..1 cs Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned Intervention moodCode . (required)
... code 1..1 CD
.... @code 1..1 cs Required Pattern: 362956003
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS
... author 0..* AuthorParticipation Base for all types and resources
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C 1..* EntryRelationship An Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1 cs Fixed Value: RSON
..... act 1..1 EntryReference Base for all types and resources
.... entryRelationship:immunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 ImmunizationActivity Base for all types and resources
.... entryRelationship:medicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 MedicationActivity Base for all types and resources
.... entryRelationship:instruction 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... act 1..1 Instruction Base for all types and resources
.... entryRelationship:nonMedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... supply 1..1 NonMedicinalSupplyActivity Base for all types and resources
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... encounter 1..1 PlannedEncounter Base for all types and resources
.... entryRelationship:plannedProcedure 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... procedure 1..1 PlannedProcedure Base for all types and resources
.... entryRelationship:plannedMedicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 PlannedMedicationActivity Base for all types and resources
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... supply 1..1 PlannedSupply Base for all types and resources
.... entryRelationship:nutritionRecommendation 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... act 1..1 NutritionRecommendation Base for all types and resources
.... entryRelationship:entryReference 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.
..... @typeCode 1..1 cs Fixed Value: REFR
..... act 1..1 EntryReference Base for all types and resources
.... entryRelationship:plannedImmunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Fixed Value: REFR
..... substanceAdministration 1..1 PlannedImmunizationActivity Base for all types and resources
... reference 0..* Reference
.... @typeCode 1..1 cs Fixed Value: REFR
.... externalDocument 1..1 ExternalDocumentReference Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.moodCoderequiredPlannedInterventionMoodCode .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54

Constraints

IdGradePath(s)DetailsRequirements
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
should-authorwarningActSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:planned-intervention-act 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1 st Required Pattern: 2015-08-01
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned Intervention moodCode . (required)
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @code 1..1 cs Required Pattern: 362956003
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: active
... effectiveTime 0..1 IVL_TS
... author 0..* AuthorParticipation Base for all types and resources
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C 1..* EntryRelationship An Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entryRelationship:immunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 ImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-doseQuantity: SHOULD contain doseQuantity
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-performer: SHOULD contain performer
should-author: SHOULD contain author
.... entryRelationship:medicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 MedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
should-routeCode: SHOULD contain routeCode
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
.... entryRelationship:instruction 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entryRelationship:nonMedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C 1..1 NonMedicinalSupplyActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedProcedure 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
.... entryRelationship:plannedMedicationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author
.... entryRelationship:nutritionRecommendation 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
.... entryRelationship:entryReference 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.
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... entryRelationship:plannedImmunizationActivity 0..* EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
... reference 0..* Reference
.... @typeCode 1..1 cs Binding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... externalDocument C 1..1 ExternalDocumentReference Base for all types and resources
should-setId: SHOULD contain setId
should-versionNumber: SHOULD contain versionNumber

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedInterventionMoodCode .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.reference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 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
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:planned-intervention-act 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.146
..... @extension 1..1 st Required Pattern: 2015-08-01
... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 cs Binding: Planned Intervention moodCode . (required)
... @negationInd 0..1 bl
... id 1..* II
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: 362956003
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: active
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1 IVL_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... languageCode 0..1 CS Binding: AllLanguages (required)
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* AuthorParticipation Base for all types and resources
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation, profile:substanceAdministration, profile:act, profile:procedure, profile:encounter, profile:supply, value:typeCode
.... entryRelationship:reason C 1..* EntryRelationship An Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
entry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:immunizationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 ImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-doseQuantity: SHOULD contain doseQuantity
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-performer: SHOULD contain performer
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:medicationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 MedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
should-routeCode: SHOULD contain routeCode
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:instruction 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 Instruction Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:nonMedSupply 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply C 1..1 NonMedicinalSupplyActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
.... entryRelationship:plannedEncounter 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter C 1..1 PlannedEncounter Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-code: SHOULD contain code
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedProcedure 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure C 1..1 PlannedProcedure Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedMedicationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedMedicationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
should-author: SHOULD contain author
..... supply 0..1 Supply
.... entryRelationship:plannedSupply 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply C 1..1 PlannedSupply Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
should-author: SHOULD contain author
.... entryRelationship:nutritionRecommendation 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 NutritionRecommendation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:entryReference 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.
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act C 1..1 EntryReference Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:plannedImmunizationActivity 0..* EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration C 1..1 PlannedImmunizationActivity Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... supply 0..1 Supply
... reference 0..* Reference
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 1..1 cs Binding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... seperatableInd 0..1 BL
.... externalAct 0..1 ExternalAct
.... externalObservation 0..1 ExternalObservation
.... externalProcedure 0..1 ExternalProcedure
.... externalDocument C 1..1 ExternalDocumentReference Base for all types and resources
should-setId: SHOULD contain setId
should-versionNumber: SHOULD contain versionNumber
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:planned-intervention-act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredPlannedInterventionMoodCode .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Act.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Act.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Act.entryRelationship:reason.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:reason.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:reason.typeCoderequiredFixed Value: RSON
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:immunizationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:immunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:immunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:medicationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:medicationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:medicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:instruction.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nonMedSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nonMedSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedEncounter.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedEncounter.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedProcedure.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProcedure.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedProcedure.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedMedicationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedMedicationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedSupply.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:nutritionRecommendation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:nutritionRecommendation.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:entryReference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryReference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryReference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.entryRelationship:plannedImmunizationActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:plannedImmunizationActivity.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Act.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.reference.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.reference.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference

Constraints

IdGradePath(s)DetailsRequirements
1098-7513warningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499).
: effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists()
dose-unit-or-admin-uniterrorAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedMedicationActivity.substanceAdministrationIf doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.
: doseQuantity.unit.exists() implies administrationUnitCode.empty()
entry-ref-goalerrorAct.entryRelationship:reasonThis entryReference template **SHALL** reference an instance of a Goal Observation template.
: %resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension))
shall-product-or-deviceerrorAct.entryRelationship:plannedSupply.supplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
: (product | participant.where(typeCode='DEV')).count() = 1
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supplySHOULD contain author
: author.exists()
should-codewarningAct.entryRelationship:plannedEncounter.encounterSHOULD contain code
: code.exists()
should-doseQuantitywarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain doseQuantity
: doseQuantity.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.actSHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningAct.entryRelationship:immunizationActivity.substanceAdministrationSHOULD contain performer
: performer.exists()
should-quantitywarningAct.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-routeCodewarningAct.entryRelationship:medicationActivity.substanceAdministrationSHOULD contain routeCode
: routeCode.exists()
should-setIdwarningAct.reference.externalDocumentSHOULD contain setId
: setId.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:reason.act, Act.entryRelationship:immunizationActivity.substanceAdministration, Act.entryRelationship:medicationActivity.substanceAdministration, Act.entryRelationship:instruction.act, Act.entryRelationship:nonMedSupply.supply, Act.entryRelationship:plannedEncounter.encounter, Act.entryRelationship:plannedProcedure.procedure, Act.entryRelationship:plannedMedicationActivity.substanceAdministration, Act.entryRelationship:plannedSupply.supply, Act.entryRelationship:nutritionRecommendation.act, Act.entryRelationship:entryReference.act, Act.entryRelationship:plannedImmunizationActivity.substanceAdministrationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-versionNumberwarningAct.reference.externalDocumentSHOULD contain versionNumber
: versionNumber.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 12 elements(12 nested mandatory elements)
Fixed: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Act.templateId
  • The element 7 is sliced based on the values of Act.entryRelationship

 

Other representations of profile: CSV, Excel