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

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

Logical Model: Planned Coverage

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedCoverage Version: 2.1
Draft as of 2023-09-29 Computable Name: PlannedCoverage
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.129

This template represents the insurance coverage intended to cover an act or procedure.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
..... extension 0..0
... code 1..1CD
.... code 1..1csRequired Pattern: 48768-6
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... typeCode 1..1csFixed Value: COMP
..... act 1..1Act
...... classCode 1..1csFixed Value: ACT
...... moodCode 1..1csFixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer (required)
...... statusCode 1..1CS
....... code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.entryRelationship:entryRelationship1.act.coderequiredPayer
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1Act
...... @classCode 1..1csFixed Value: ACT
...... @moodCode 1..1csFixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer (required)
...... statusCode 1..1CSBinding: ActStatus (required)
....... @code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.coderequiredPayer
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: INT
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... id 1..*II
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: 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_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1Act
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @classCode 1..1csFixed Value: ACT
...... @moodCode 1..1csFixed Value: INT
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer (required)
...... @negationInd 0..1bl
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... @nullFlavor 0..1csBinding: NullFlavor (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_TS
...... priorityCode 0..1CEBinding: ActPriority (extensible)
...... languageCode 0..1CSBinding: HumanLanguage (required)
...... subject 0..1Subject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Informant
...... participant 0..*Participant2
...... entryRelationship 0..*EntryRelationship
...... reference 0..*Reference
...... precondition 0..*Precondition
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredNullFlavor
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.entryRelationship:entryRelationship1.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.act.coderequiredPayer
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.act.statusCode.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.act.priorityCodeextensibleActPriority
Act.entryRelationship:entryRelationship1.act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 14 elements
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
..... extension 0..0
... code 1..1CD
.... code 1..1csRequired Pattern: 48768-6
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... typeCode 1..1csFixed Value: COMP
..... act 1..1Act
...... classCode 1..1csFixed Value: ACT
...... moodCode 1..1csFixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer (required)
...... statusCode 1..1CS
....... code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.entryRelationship:entryRelationship1.act.coderequiredPayer

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: INT
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1Act
...... @classCode 1..1csFixed Value: ACT
...... @moodCode 1..1csFixed Value: INT
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer (required)
...... statusCode 1..1CSBinding: ActStatus (required)
....... @code 1..1csFixed Value: active

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.coderequiredPayer
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: INT
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.129
... id 1..*II
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 48768-6
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: 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_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 1..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:entryRelationship1 1..1EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1Act
...... @nullFlavor 0..1csBinding: NullFlavor (required)
...... @classCode 1..1csFixed Value: ACT
...... @moodCode 1..1csFixed Value: INT
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 1..*IIThese act/identifiers are unique identifiers for the policy or program providing the coverage.
...... code 1..1CDBinding: Payer (required)
...... @negationInd 0..1bl
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... @nullFlavor 0..1csBinding: NullFlavor (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_TS
...... priorityCode 0..1CEBinding: ActPriority (extensible)
...... languageCode 0..1CSBinding: HumanLanguage (required)
...... subject 0..1Subject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Informant
...... participant 0..*Participant2
...... entryRelationship 0..*EntryRelationship
...... reference 0..*Reference
...... precondition 0..*Precondition
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredNullFlavor
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.entryRelationship:entryRelationship1.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: COMP
Act.entryRelationship:entryRelationship1.act.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.act.coderequiredPayer
Act.entryRelationship:entryRelationship1.act.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.act.statusCode.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.act.priorityCodeextensibleActPriority
Act.entryRelationship:entryRelationship1.act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 14 elements
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel