Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
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
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorizationActivity | Version: 2.1 | |||
| Draft as of 2023-09-29 | 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 CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Act | 1..1 | CDAR2.Act | XML 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..1 | cs | Fixed Value: ACT | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
   templateId:primary | 1..1 | II | ||
  root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
  extension | 0..0 | |||
| id | 1..1 | II | ||
 Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | 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). 81-8952: 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). |
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | warning | 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 or observation or procedure or substanceAdministration or supply | |
| 81-8952 | warning | Act.entryRelationship:target | 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). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML 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..1 | cs | Fixed Value: ACT | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
 id | 1..1 | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | 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). 81-8952: 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). |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.code | extensible | ActCode |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | warning | 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 or observation or procedure or substanceAdministration or supply | |
| 81-8952 | warning | Act.entryRelationship:target | 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). : | |
| 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.nullFlavor | required | NullFlavor |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.entryRelationship:target.nullFlavor | required | NullFlavor |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | warning | 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 or observation or procedure or substanceAdministration or supply | |
| 81-8952 | warning | Act.entryRelationship:target | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.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 CDAR2.Act
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML 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..1 | cs | Fixed Value: ACT | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
| extension | 0..0 | |||
| id | 1..1 | II | ||
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | 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). 81-8952: 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). |
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | warning | 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 or observation or procedure or substanceAdministration or supply | |
| 81-8952 | warning | Act.entryRelationship:target | 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). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | XML 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..1 | cs | Fixed Value: ACT | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.19 | |
| id | 1..1 | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by value:typeCode | |
| entryRelationship:target | C | 1..* | EntryRelationship | 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). 81-8952: 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). |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.code | extensible | ActCode |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | warning | 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 or observation or procedure or substanceAdministration or supply | |
| 81-8952 | warning | Act.entryRelationship:target | 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). : | |
| 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.nullFlavor | required | NullFlavor |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.entryRelationship:target.nullFlavor | required | NullFlavor |
| Act.entryRelationship:target.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 81-8951 | warning | 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 or observation or procedure or substanceAdministration or supply | |
| 81-8952 | warning | Act.entryRelationship:target | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.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#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change
