Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/CoverageActivity | Version: 4.0.0-ballot | |||
| Draft as of 2024-11-21 | Computable Name: CoverageActivity | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.60:2024-05-01 | ||||
A Coverage Activity groups the policy and authorization acts within a Payers Section to order the payment sources. A Coverage Activity contains one or more Policy Activities, each of which contains zero or more Authorization Activities. The sequenceNumber/@value shows the policy order of preference. The Member Identifier is described in the contained Policy Activity Template 2.16.840.1.113883.10.20.22.4.61.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:coverage-activity |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.60 | |
  @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
 @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | Display: Payment sources. (USCDI) COVERAGE TYPE: Records the category of health care payers, insurance products, or benefits. | |
| @code |
1..1 | cs | Required Pattern: 52556-8 | |
 @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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: completed | |
| effectiveTime |
0..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: COVERAGE STATUS : Records the date and time when you checked and possibly updated the coverage for a patient, and applies for all policies within the coverage activity. Multiple Coverage Activity Acts would be needed to convey different times when coverage was checked and possibly updated. Details on a specific Policy coverage period, or self-pay period, systems can record an additional time inside the Policy Activity/coverage-target participant. Systems may prioritize Coverages using the sequenceNumber. | |
| @value |
1..1 | ts | ||
 Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by profile:act, value:typeCode | |
| entryRelationship:policy |
1..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Fixed Value: COMP | |
 sequenceNumber |
0..1 | INT | ||
 @value |
1..1 | int | ||
 act |
1..1 | PolicyActivity | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:coverage-activity |
1..1 | II | ||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.60 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | Display: Payment sources. (USCDI) COVERAGE TYPE: Records the category of health care payers, insurance products, or benefits. Binding: v3 Code System ActCode (example) | |
| @code |
1..1 | cs | Required Pattern: 52556-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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: completed | |
| effectiveTime |
0..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: COVERAGE STATUS : Records the date and time when you checked and possibly updated the coverage for a patient, and applies for all policies within the coverage activity. Multiple Coverage Activity Acts would be needed to convey different times when coverage was checked and possibly updated. Details on a specific Policy coverage period, or self-pay period, systems can record an additional time inside the Policy Activity/coverage-target participant. Systems may prioritize Coverages using the sequenceNumber. | |
| @value |
1..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by profile:act, value:typeCode | |
| entryRelationship:policy |
1..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| sequenceNumber |
0..1 | INT | ||
| @value |
1..1 | int | ||
| act |
C | 1..1 | PolicyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 4537-17139: When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.entryRelationship:policy.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-17139 | error | Act.entryRelationship:policy.act | When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : participant.where(typeCode='COV').participantRole.code.where(code = 'SELF').exists() implies participant.where(typeCode='HLD').empty() | |
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:policy.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| @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 | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:coverage-activity |
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.60 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
1..* | II | ||
| code |
1..1 | CD | Display: Payment sources. (USCDI) COVERAGE TYPE: Records the category of health care payers, insurance products, or benefits. Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 52556-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| @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: completed | |
| @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 | 𝗨𝗦𝗖𝗗𝗜: COVERAGE STATUS : Records the date and time when you checked and possibly updated the coverage for a patient, and applies for all policies within the coverage activity. Multiple Coverage Activity Acts would be needed to convey different times when coverage was checked and possibly updated. Details on a specific Policy coverage period, or self-pay period, systems can record an additional time inside the Policy Activity/coverage-target participant. Systems may prioritize Coverages using the sequenceNumber. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
0..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_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..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by profile:act, value:typeCode | |
| entryRelationship:policy |
1..* | EntryRelationship | 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: COMP | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | int | ||
| seperatableInd |
0..1 | BL | ||
| act |
C | 1..1 | PolicyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 4537-17139: When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
| 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 | ||
| reference |
0..* | Reference | ||
| 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) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.templateId:coverage-activity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Act.entryRelationship:policy.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:policy.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:policy.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:policy.sequenceNumber.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-17139 | error | Act.entryRelationship:policy.act | When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : participant.where(typeCode='COV').participantRole.code.where(code = 'SELF').exists() implies participant.where(typeCode='HLD').empty() | |
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:policy.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Act
Summary
Mandatory: 12 elements(2 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:coverage-activity |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.60 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | Display: Payment sources. (USCDI) COVERAGE TYPE: Records the category of health care payers, insurance products, or benefits. | |
| @code |
1..1 | cs | Required Pattern: 52556-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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: completed | |
| effectiveTime |
0..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: COVERAGE STATUS : Records the date and time when you checked and possibly updated the coverage for a patient, and applies for all policies within the coverage activity. Multiple Coverage Activity Acts would be needed to convey different times when coverage was checked and possibly updated. Details on a specific Policy coverage period, or self-pay period, systems can record an additional time inside the Policy Activity/coverage-target participant. Systems may prioritize Coverages using the sequenceNumber. | |
| @value |
1..1 | ts | ||
| Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by profile:act, value:typeCode | |
| entryRelationship:policy |
1..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Fixed Value: COMP | |
| sequenceNumber |
0..1 | INT | ||
| @value |
1..1 | int | ||
| act |
1..1 | PolicyActivity | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:coverage-activity |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.60 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
1..1 | CD | Display: Payment sources. (USCDI) COVERAGE TYPE: Records the category of health care payers, insurance products, or benefits. Binding: v3 Code System ActCode (example) | |
| @code |
1..1 | cs | Required Pattern: 52556-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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: completed | |
| effectiveTime |
0..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: COVERAGE STATUS : Records the date and time when you checked and possibly updated the coverage for a patient, and applies for all policies within the coverage activity. Multiple Coverage Activity Acts would be needed to convey different times when coverage was checked and possibly updated. Details on a specific Policy coverage period, or self-pay period, systems can record an additional time inside the Policy Activity/coverage-target participant. Systems may prioritize Coverages using the sequenceNumber. | |
| @value |
1..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by profile:act, value:typeCode | |
| entryRelationship:policy |
1..* | EntryRelationship | entryRelationship | |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| sequenceNumber |
0..1 | INT | ||
| @value |
1..1 | int | ||
| act |
C | 1..1 | PolicyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 4537-17139: When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.entryRelationship:policy.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-17139 | error | Act.entryRelationship:policy.act | When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : participant.where(typeCode='COV').participantRole.code.where(code = 'SELF').exists() implies participant.where(typeCode='HLD').empty() | |
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:policy.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| @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 | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:coverage-activity |
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.60 | |
| @extension |
1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
| @negationInd |
0..1 | bl | ||
| id |
1..* | II | ||
| code |
1..1 | CD | Display: Payment sources. (USCDI) COVERAGE TYPE: Records the category of health care payers, insurance products, or benefits. Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 52556-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| @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: completed | |
| @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 | 𝗨𝗦𝗖𝗗𝗜: COVERAGE STATUS : Records the date and time when you checked and possibly updated the coverage for a patient, and applies for all policies within the coverage activity. Multiple Coverage Activity Acts would be needed to convey different times when coverage was checked and possibly updated. Details on a specific Policy coverage period, or self-pay period, systems can record an additional time inside the Policy Activity/coverage-target participant. Systems may prioritize Coverages using the sequenceNumber. | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |
| low |
0..1 | IVXB_TS | ||
| center |
0..1 | TS | ||
| width |
0..1 | PQ | ||
| high |
0..1 | IVXB_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..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by profile:act, value:typeCode | |
| entryRelationship:policy |
1..* | EntryRelationship | 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: COMP | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | int | ||
| seperatableInd |
0..1 | BL | ||
| act |
C | 1..1 | PolicyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value 4537-17139: When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). |
| 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 | ||
| reference |
0..* | Reference | ||
| 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) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.templateId:coverage-activity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
| Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
| Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Act.entryRelationship:policy.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:policy.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Act.entryRelationship:policy.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Act.entryRelationship:policy.sequenceNumber.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-17139 | error | Act.entryRelationship:policy.act | When the Subscriber is the patient (COV participant code = 'SELF'), the participant element describing the subscriber **SHALL NOT** be present. This information will be recorded instead in the data elements used to record member information (CONF:4537-17139). : participant.where(typeCode='COV').participantRole.code.where(code = 'SELF').exists() implies participant.where(typeCode='HLD').empty() | |
| should-effectiveTime | warning | Act | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Act.entryRelationship:policy.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Act
Summary
Mandatory: 12 elements(2 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-11-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change