This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.129 | Version: 2.1.0-draft1 | |||
Active as of 2023-01-16 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.129 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
code | 1..1 | string | Required Pattern: 48768-6 | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
author | 0..* | AuthorParticipation | Base for all types and resources | |
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:act | |
entryRelationship:entryRelationship1 | 1..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: COMP | |
act | 1..1 | Act | ||
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
id | 1..* | II | These act/identifiers are unique identifiers for the policy or program providing the coverage. | |
code | 1..1 | CD | Binding: Payer (required) | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.entryRelationship:entryRelationship1.act.code | required | Payer |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.129 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
code | 1..1 | string | Required Pattern: 48768-6 | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: active | |
author | 0..* | AuthorParticipation | Base for all types and resources | |
Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by profile:act |
entryRelationship:All Slices | Content/Rules for all slices | |||
typeCode | 1..1 | code | ||
contextConductionInd | 1..1 | boolean | ||
entryRelationship:entryRelationship1 | C | 1..1 | Element | |
typeCode | 1..1 | code | Required Pattern: COMP | |
contextConductionInd | 1..1 | boolean | ||
act | 1..1 | Act | ||
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
id | 1..* | II | These act/identifiers are unique identifiers for the policy or program providing the coverage. | |
code | 1..1 | CD | Binding: Payer (required) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: active | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.code | extensible | ActCode |
Act.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.act.code | required | Payer |
Act.entryRelationship:entryRelationship1.act.statusCode | required | ActStatus |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Path | Conformance | ValueSet / Code |
Act.templateId:primary.nullFlavor | required | NullFlavor |
Act.code | extensible | ActCode |
Act.code.nullFlavor | required | NullFlavor |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | NullFlavor |
Act.priorityCode | extensible | ActPriority |
Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.subject.typeCode | required | Fixed Value: SBJ |
Act.subject.contextControlCode | required | Fixed Value: OP |
Act.subject.awarenessCode | extensible | TargetAwareness |
Act.informant.typeCode | required | Fixed Value: INF |
Act.informant.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.act.code | required | Payer |
Act.entryRelationship:entryRelationship1.act.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.act.statusCode.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.act.priorityCode | extensible | ActPriority |
Act.entryRelationship:entryRelationship1.act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.entryRelationship:entryRelationship1.act.subject.typeCode | required | Fixed Value: SBJ |
Act.entryRelationship:entryRelationship1.act.subject.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.act.subject.awarenessCode | extensible | TargetAwareness |
Act.entryRelationship:entryRelationship1.act.informant.typeCode | required | Fixed Value: INF |
Act.entryRelationship:entryRelationship1.act.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:entryRelationship1.act.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CDAR2.Act
Summary
Mandatory: 19 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.129 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
code | 1..1 | string | Required Pattern: 48768-6 | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
author | 0..* | AuthorParticipation | Base for all types and resources | |
Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:act | |
entryRelationship:entryRelationship1 | 1..1 | Element | ||
typeCode | 1..1 | code | Required Pattern: COMP | |
act | 1..1 | Act | ||
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
id | 1..* | II | These act/identifiers are unique identifiers for the policy or program providing the coverage. | |
code | 1..1 | CD | Binding: Payer (required) | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.entryRelationship:entryRelationship1.act.code | required | Payer |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.129 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
code | 1..1 | string | Required Pattern: 48768-6 | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.6.1 | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: active | |
author | 0..* | AuthorParticipation | Base for all types and resources | |
Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by profile:act |
entryRelationship:All Slices | Content/Rules for all slices | |||
typeCode | 1..1 | code | ||
contextConductionInd | 1..1 | boolean | ||
entryRelationship:entryRelationship1 | C | 1..1 | Element | |
typeCode | 1..1 | code | Required Pattern: COMP | |
contextConductionInd | 1..1 | boolean | ||
act | 1..1 | Act | ||
classCode | 1..1 | code | Required Pattern: ACT | |
moodCode | 1..1 | code | Required Pattern: INT | |
id | 1..* | II | These act/identifiers are unique identifiers for the policy or program providing the coverage. | |
code | 1..1 | CD | Binding: Payer (required) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: active | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.code | extensible | ActCode |
Act.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.act.code | required | Payer |
Act.entryRelationship:entryRelationship1.act.statusCode | required | ActStatus |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Path | Conformance | ValueSet / Code |
Act.templateId:primary.nullFlavor | required | NullFlavor |
Act.code | extensible | ActCode |
Act.code.nullFlavor | required | NullFlavor |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | NullFlavor |
Act.priorityCode | extensible | ActPriority |
Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.subject.typeCode | required | Fixed Value: SBJ |
Act.subject.contextControlCode | required | Fixed Value: OP |
Act.subject.awarenessCode | extensible | TargetAwareness |
Act.informant.typeCode | required | Fixed Value: INF |
Act.informant.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.act.code | required | Payer |
Act.entryRelationship:entryRelationship1.act.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.act.statusCode.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.act.priorityCode | extensible | ActPriority |
Act.entryRelationship:entryRelationship1.act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.entryRelationship:entryRelationship1.act.subject.typeCode | required | Fixed Value: SBJ |
Act.entryRelationship:entryRelationship1.act.subject.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.act.subject.awarenessCode | extensible | TargetAwareness |
Act.entryRelationship:entryRelationship1.act.informant.typeCode | required | Fixed Value: INF |
Act.entryRelationship:entryRelationship1.act.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:entryRelationship1.act.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CDAR2.Act
Summary
Mandatory: 19 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron