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/Instruction | Version: 2.1 | |||
| Draft as of 2023-09-29 | Computable Name: Instruction | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09 | ||||
The Instruction template can be used in several ways, such as to record patient instructions within a Medication Activity or to record fill instructions within a supply order. The template’s moodCode can only be INT. If an instruction was already given, the Procedure Activity Procedure template (instead of this template) should be used to represent the already occurred instruction. The act/code defines the type of instruction. Though not defined in this template, a Vaccine Information Statement (VIS) document could be referenced through act/reference/externalDocument, and patient awareness of the instructions can be represented with the generic participant and the participant/awarenessCode.
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: INT | |
  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.20 | |
  extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| code | 1..1 | CD | Binding: Patient Education (preferred) | |
 statusCode | 1..1 | CS | ||
 code | 1..1 | cs | Fixed Value: completed | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.code | preferred | Patient Education |
| 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: INT | |
| 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.20 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
 code | 1..1 | CD | Binding: Patient Education (preferred) | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.code | preferred | Patient Education |
| Act.statusCode | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Path | Conformance | ValueSet |
| Act.nullFlavor | required | NullFlavor |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | preferred | Patient Education |
| 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) |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
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: INT | |
| 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.20 | |
| extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| code | 1..1 | CD | Binding: Patient Education (preferred) | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Fixed Value: completed | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.code | preferred | Patient Education |
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: INT | |
| 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.20 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| code | 1..1 | CD | Binding: Patient Education (preferred) | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.code | preferred | Patient Education |
| Act.statusCode | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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 |
| Act.nullFlavor | required | NullFlavor |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | preferred | Patient Education |
| 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) |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
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