Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Planned Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedAct Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: PlannedAct
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.39:2014-06-09

This template represents planned acts that are not classified as an observation or a procedure according to the HL7 RIM. Examples of these acts are a dressing change, the teaching or feeding of a patient or the providing of comfort measures. The priority of the activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the activity is intended to take place.

Usage:

Formal Views of Profile Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.39
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code C1..1CD1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime in a planned act represents the time that the act should occur.
... performer 0..*Performer2The clinician who is expected to carry out the act could be identified using act/performer.
... author 0..1AuthorParticipationThe author in a planned act represents the clinician who is requesting or planning the act.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned act.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the activity.
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the act.
..... @typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure

Constraints

IdGradePath(s)DetailsRequirements
1098-32030warningAct.codeThis code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningActSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.39
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code C1..1CDBinding: v3 Code System ActCode (example)
1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime in a planned act represents the time that the act should occur.
... performer 0..*Performer2The clinician who is expected to carry out the act could be identified using act/performer.
... author 0..1AuthorParticipationThe author in a planned act represents the clinician who is requesting or planning the act.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned act.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the activity.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the act.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation C1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act C1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Act.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-32030warningAct.codeThis code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observation, Act.entryRelationship:instruction.actSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:planned-act 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.39
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... @negationInd 0..1bl
... id 1..*II
... code C1..1CDBinding: v3 Code System ActCode (example)
1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TSThe effectiveTime in a planned act represents the time that the act should occur.
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to carry out the act could be identified using act/performer.
... author 0..1AuthorParticipationThe author in a planned act represents the clinician who is requesting or planning the act.
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned act.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the activity.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the act.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:instruction 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:planned-act.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codeexampleActCode
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Act.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-32030warningAct.codeThis code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observation, Act.entryRelationship:instruction.actSHOULD 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('#')

This structure is derived from Act

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.39
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code C1..1CD1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime in a planned act represents the time that the act should occur.
... performer 0..*Performer2The clinician who is expected to carry out the act could be identified using act/performer.
... author 0..1AuthorParticipationThe author in a planned act represents the clinician who is requesting or planning the act.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned act.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the activity.
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the act.
..... @typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csFixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure

Constraints

IdGradePath(s)DetailsRequirements
1098-32030warningAct.codeThis code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningActSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:planned-act 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.39
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... code C1..1CDBinding: v3 Code System ActCode (example)
1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1IVL_TSThe effectiveTime in a planned act represents the time that the act should occur.
... performer 0..*Performer2The clinician who is expected to carry out the act could be identified using act/performer.
... author 0..1AuthorParticipationThe author in a planned act represents the clinician who is requesting or planning the act.
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned act.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the activity.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the act.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation C1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act C1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Act.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-32030warningAct.codeThis code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observation, Act.entryRelationship:instruction.actSHOULD 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('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:planned-act 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.39
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: Planned moodCode (Act/Encounter/Procedure) (required)
... @negationInd 0..1bl
... id 1..*II
... code C1..1CDBinding: v3 Code System ActCode (example)
1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TSThe effectiveTime in a planned act represents the time that the act should occur.
... priorityCode 0..1CEBinding: ActPriority (example)
... languageCode 0..1CSBinding: AllLanguages (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to carry out the act could be identified using act/performer.
... author 0..1AuthorParticipationThe author in a planned act represents the clinician who is requesting or planning the act.
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned act.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the activity.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the act.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:instruction 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:planned-act.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredPlannedMoodCodeActEncounterProcedure
Act.codeexampleActCode
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Act.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Act.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
Act.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-32030warningAct.codeThis code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningActSHOULD contain author
: author.exists()
should-authorwarningAct.entryRelationship:priorityPreference.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningActSHOULD contain effectiveTime
: effectiveTime.exists()
should-effectiveTimewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningAct.entryRelationship:priorityPreference.observation, Act.entryRelationship:indication.observation, Act.entryRelationship:instruction.actSHOULD 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('#')

This structure is derived from Act

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel