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/AllergyConcernAct | Version: 2.1 | |||
| Draft as of 2023-09-29 | Computable Name: AllergyConcernAct | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.30:2015-08-01 | ||||
This template reflects an ongoing concern on behalf of the provider that placed the allergy on a patient’s allergy list. As long as the underlying condition is of concern to the provider (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the provider), the statusCode is “active”. Only when the underlying allergy is no longer of concern is the statusCode set to “completed”. The effectiveTime reflects the time that the underlying allergy was felt to be a concern.
The statusCode of the Allergy Concern Act is the definitive indication of the status of the concern, whereas the effectiveTime of the nested Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy is resolved.
The effectiveTime/low of the Allergy Concern Act asserts when the concern became active. This equates to the time the concern was authored in the patient’s chart. The effectiveTime/high asserts when the concern was completed (e.g., when the clinician deemed there is no longer any need to track the underlying condition).
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 | 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 | ||
 classCode | 1..1 | cs | Fixed Value: ACT | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:extension, value:root | |
   templateId:primary | 1..1 | II | ||
  root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.30 | |
  extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | cs | Required Pattern: CONC | |
 codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.6 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Binding: ProblemAct statusCode (required) | |
| effectiveTime | C | 1..1 | IVL_TS | 1198-10085: If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). 1198-7504: If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). |
 author | 0..* | AuthorParticipation | Base for all types and resources | |
 Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |
| entryRelationship:allergyObs | 1..1 | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| observation | 1..1 | AllergyIntoleranceObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.statusCode.code | required | ProblemAct statusCode |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-7504 | error | Act.effectiveTime | If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). : | |
| 1198-10085 | error | Act.effectiveTime | If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). : |
| 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:extension, value:root | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.30 | |
| @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| @code | 1..1 | cs | Required Pattern: CONC | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.6 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Binding: ProblemAct statusCode (required) | |
| effectiveTime | C | 1..1 | IVL_TS | 1198-10085: If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). 1198-7504: If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). |
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |
| entryRelationship:allergyObs | 1..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| observation | 1..1 | AllergyIntoleranceObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.statusCode.code | required | ProblemAct statusCode |
| Act.entryRelationship:allergyObs.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-7504 | error | Act.effectiveTime | If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). : | |
| 1198-10085 | error | Act.effectiveTime | If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). : | |
| 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.code.nullFlavor | required | NullFlavor |
| Act.statusCode | required | ActStatus |
| Act.statusCode.nullFlavor | required | NullFlavor |
| Act.statusCode.code | required | ProblemAct statusCode |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.entryRelationship:allergyObs.nullFlavor | required | NullFlavor |
| Act.entryRelationship:allergyObs.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-7504 | error | Act.effectiveTime | If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). : | |
| 1198-10085 | error | Act.effectiveTime | If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). : | |
| 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: 13 elements
Fixed Value: 3 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 | 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 | ||
| classCode | 1..1 | cs | Fixed Value: ACT | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:extension, value:root | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.30 | |
| extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | cs | Required Pattern: CONC | |
| codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.6 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Binding: ProblemAct statusCode (required) | |
| effectiveTime | C | 1..1 | IVL_TS | 1198-10085: If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). 1198-7504: If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). |
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |
| entryRelationship:allergyObs | 1..1 | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| observation | 1..1 | AllergyIntoleranceObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.statusCode.code | required | ProblemAct statusCode |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-7504 | error | Act.effectiveTime | If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). : | |
| 1198-10085 | error | Act.effectiveTime | If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). : |
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:extension, value:root | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.30 | |
| @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| @code | 1..1 | cs | Required Pattern: CONC | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.6 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Binding: ProblemAct statusCode (required) | |
| effectiveTime | C | 1..1 | IVL_TS | 1198-10085: If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). 1198-7504: If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). |
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 1..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |
| entryRelationship:allergyObs | 1..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| observation | 1..1 | AllergyIntoleranceObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Act.statusCode.code | required | ProblemAct statusCode |
| Act.entryRelationship:allergyObs.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-7504 | error | Act.effectiveTime | If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). : | |
| 1198-10085 | error | Act.effectiveTime | If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). : | |
| 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.code.nullFlavor | required | NullFlavor |
| Act.statusCode | required | ActStatus |
| Act.statusCode.nullFlavor | required | NullFlavor |
| Act.statusCode.code | required | ProblemAct statusCode |
| Act.priorityCode | extensible | ActPriority |
| Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Act.entryRelationship:allergyObs.nullFlavor | required | NullFlavor |
| Act.entryRelationship:allergyObs.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-7504 | error | Act.effectiveTime | If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). : | |
| 1198-10085 | error | Act.effectiveTime | If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). : | |
| 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: 13 elements
Fixed Value: 3 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#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change