Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
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
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorizationActivity | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: AuthorizationActivity | |||
| Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.1.19 | ||||
An Authorization Activity represents authorizations or pre-authorizations currently active for the patient for the particular payer.
Authorizations are represented using an act subordinate to the policy or program that provided it. The authorization refers to the policy or program. Authorized treatments can be grouped into an organizer class, where common properties, such as the reason for the authorization, can be expressed. Subordinate acts represent what was authorized.
Usage:
Description of Profiles, 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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
   templateId:authorization-activity | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
  @extension | 0..0 | |||
 @classCode | 1..1 | cs | Fixed Value: ACT | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| id | 1..1 | II | ||
| 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 |
 Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). 81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). |
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | error | Act.entryRelationship:target | The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:authorization-activity | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
| @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..1 | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
| 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 |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). 81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.classCode | required | Fixed Value: ACT |
| Act.moodCode | required | Fixed Value: EVN |
| Act.code | example | ActCode |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | error | Act.entryRelationship:target | The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').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('#') |
| Path | Conformance | ValueSet / Code |
| Act.nullFlavor | required | CDANullFlavor |
| Act.typeId.nullFlavor | required | CDANullFlavor |
| Act.templateId:authorization-activity.nullFlavor | required | CDANullFlavor |
| Act.classCode | required | Fixed Value: ACT |
| Act.moodCode | required | Fixed Value: EVN |
| Act.code | example | ActCode |
| Act.text.nullFlavor | required | CDANullFlavor |
| Act.text.compression | required | CDACompressionAlgorithm |
| Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Act.text.mediaType | example | MediaType |
| Act.text.representation | required | BinaryDataEncoding |
| Act.statusCode | required | ActStatus |
| Act.priorityCode | example | ActPriority |
| Act.languageCode | required | AllLanguages |
| Act.entryRelationship:target.nullFlavor | required | CDANullFlavor |
| Act.entryRelationship:target.typeId.nullFlavor | required | CDANullFlavor |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | error | Act.entryRelationship:target | The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').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('#') |
This structure is derived from Act
Summary
Mandatory: 6 elements
Fixed Value: 3 elements
Prohibited: 1 element
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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:authorization-activity | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
| @extension | 0..0 | |||
| @classCode | 1..1 | cs | Fixed Value: ACT | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| id | 1..1 | II | ||
| 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 |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). 81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). |
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | error | Act.entryRelationship:target | The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:authorization-activity | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
| @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..1 | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
| 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 |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). 81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.classCode | required | Fixed Value: ACT |
| Act.moodCode | required | Fixed Value: EVN |
| Act.code | example | ActCode |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | error | Act.entryRelationship:target | The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').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('#') |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Act.nullFlavor | required | CDANullFlavor |
| Act.typeId.nullFlavor | required | CDANullFlavor |
| Act.templateId:authorization-activity.nullFlavor | required | CDANullFlavor |
| Act.classCode | required | Fixed Value: ACT |
| Act.moodCode | required | Fixed Value: EVN |
| Act.code | example | ActCode |
| Act.text.nullFlavor | required | CDANullFlavor |
| Act.text.compression | required | CDACompressionAlgorithm |
| Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Act.text.mediaType | example | MediaType |
| Act.text.representation | required | BinaryDataEncoding |
| Act.statusCode | required | ActStatus |
| Act.priorityCode | example | ActPriority |
| Act.languageCode | required | AllLanguages |
| Act.entryRelationship:target.nullFlavor | required | CDANullFlavor |
| Act.entryRelationship:target.typeId.nullFlavor | required | CDANullFlavor |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | error | Act.entryRelationship:target | The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').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('#') |
This structure is derived from Act
Summary
Mandatory: 6 elements
Fixed Value: 3 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change
