Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR 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/2.16.840.1.113883.10.20.22.4.39 | Version: 2.1.0-draft1 | |||
| Active as of 2023-01-16 | Computable Name: PlannedAct | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.39:2014-06-09 | ||||
This template represents planned acts that are not classified as an observation or a procedure according to the HL7 RIM. Examples of these acts are a dressing change, the teaching or feeding of a patient or the providing of comfort measures. The priority of the activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the activity is intended to take place.
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 | Base for all types and resources | |
 classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
  Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary | 1..1 | II | ||
  root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
  extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | ||
 code | 1..1 | string | Required Pattern: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
 author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
 Slices for entryRelationship | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act | |
 entryRelationship:priorityPreference | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity. | |
 typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the act. | |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | Base for all types and resources | |
 classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | Binding: v3 Code System ActCode (extensible) 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| code | 1..1 | string | Required Pattern: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| Slices for entryRelationship | C | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act |
| entryRelationship:All Slices | Content/Rules for all slices | |||
 typeCode | 1..1 | code | ||
 contextConductionInd | 1..1 | boolean | ||
| entryRelationship:priorityPreference | C | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity. |
| typeCode | 1..1 | code | Required Pattern: REFR | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | C | 0..* | Element | The following entryRelationship represents the indication for the act. |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | C | 0..* | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| contextConductionInd | 1..1 | boolean | ||
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| act-er-1 | error | Act.entryRelationship, Act.entryRelationship:priorityPreference, Act.entryRelationship:indication, Act.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | Base for all types and resources | |
| classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| assigningAuthorityName | 0..1 | string | ||
| displayable | 0..1 | boolean | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | Binding: v3 Code System ActCode (extensible) 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| negationInd | 0..1 | boolean | ||
| text | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Required Pattern: active | |
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
 subject | 0..1 | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
| relatedSubject | 1..1 | RelatedSubject | ||
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| informant | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| assignedEntity | 0..1 | AssignedEntity | ||
| relatedEntity | 0..1 | RelatedEntity | ||
| participant | 0..* | Participant2 | ||
| Slices for entryRelationship | C | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act |
| entryRelationship:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | ||
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
 (Choice of one) | 1..1 | |||
| observation | 0..1 | Observation | ||
| regionOfInterest | 0..1 | RegionOfInterest | ||
| observationMedia | 0..1 | ObservationMedia | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| procedure | 0..1 | Procedure | ||
| encounter | 0..1 | Encounter | ||
| organizer | 0..1 | Organizer | ||
| act | 0..1 | Act | ||
| entryRelationship:priorityPreference | C | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: REFR | |
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | C | 0..* | Element | The following entryRelationship represents the indication for the act. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | C | 0..* | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| act | 1..1 | Instruction | Base for all types and resources | |
| reference | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | ||
| seperatableInd | 0..1 | BL | ||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| precondition | 0..* | Precondition | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| 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) |
| Act.subject.typeCode | required | Fixed Value: SBJ |
| Act.subject.contextControlCode | required | Fixed Value: OP |
| Act.subject.awarenessCode | extensible | TargetAwareness |
| Act.informant.typeCode | required | Fixed Value: INF |
| Act.informant.contextControlCode | required | Fixed Value: OP |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| act-er-1 | error | Act.entryRelationship, Act.entryRelationship:priorityPreference, Act.entryRelationship:indication, Act.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CDAR2.Act
Summary
Mandatory: 9 elements (6 nested mandatory 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 | 1..1 | CDAR2.Act | Base for all types and resources | |
| classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | ||
| code | 1..1 | string | Required Pattern: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| Slices for entryRelationship | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act | |
| entryRelationship:priorityPreference | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity. | |
| typeCode | 1..1 | code | Required Pattern: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the act. | |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | Element | ||
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | Base for all types and resources | |
| classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | Binding: v3 Code System ActCode (extensible) 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| code | 1..1 | string | Required Pattern: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| Slices for entryRelationship | C | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act |
| entryRelationship:All Slices | Content/Rules for all slices | |||
| typeCode | 1..1 | code | ||
| contextConductionInd | 1..1 | boolean | ||
| entryRelationship:priorityPreference | C | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity. |
| typeCode | 1..1 | code | Required Pattern: REFR | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | C | 0..* | Element | The following entryRelationship represents the indication for the act. |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | C | 0..* | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| contextConductionInd | 1..1 | boolean | ||
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.code | extensible | ActCode |
| Act.statusCode | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| act-er-1 | error | Act.entryRelationship, Act.entryRelationship:priorityPreference, Act.entryRelationship:indication, Act.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Act | 1..1 | CDAR2.Act | Base for all types and resources | |
| classCode | 1..1 | code | Required Pattern: ACT | |
| moodCode | 1..1 | code | Binding: Planned moodCode (Act/Encounter/Procedure) (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| assigningAuthorityName | 0..1 | string | ||
| displayable | 0..1 | boolean | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.39 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | C | 1..1 | CD | Binding: v3 Code System ActCode (extensible) 1098-32030: This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). |
| negationInd | 0..1 | boolean | ||
| text | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Required Pattern: active | |
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned act represents the time that the act should occur. | |
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
| subject | 0..1 | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
| relatedSubject | 1..1 | RelatedSubject | ||
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | The clinician who is expected to carry out the act could be identified using act/performer. | |
| author | 0..1 | AuthorParticipation | The author in a planned act represents the clinician who is requesting or planning the act. | |
| informant | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| assignedEntity | 0..1 | AssignedEntity | ||
| relatedEntity | 0..1 | RelatedEntity | ||
| participant | 0..* | Participant2 | ||
| Slices for entryRelationship | C | 0..* | Element | The following entryRelationship captures any instructions associated with the planned act. Slice: Unordered, Open by profile:act |
| entryRelationship:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | ||
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| (Choice of one) | 1..1 | |||
| observation | 0..1 | Observation | ||
| regionOfInterest | 0..1 | RegionOfInterest | ||
| observationMedia | 0..1 | ObservationMedia | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| procedure | 0..1 | Procedure | ||
| encounter | 0..1 | Encounter | ||
| organizer | 0..1 | Organizer | ||
| act | 0..1 | Act | ||
| entryRelationship:priorityPreference | C | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the activity. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: REFR | |
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | C | 0..* | Element | The following entryRelationship represents the indication for the act. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: RSON | |
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | C | 0..* | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 0..1 | boolean | ||
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| act | 1..1 | Instruction | Base for all types and resources | |
| reference | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | ||
| seperatableInd | 0..1 | BL | ||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| precondition | 0..* | Precondition | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Act.moodCode | required | Planned moodCode (Act/Encounter/Procedure) |
| Act.templateId:primary.nullFlavor | required | NullFlavor |
| Act.code | extensible | ActCode |
| 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) |
| Act.subject.typeCode | required | Fixed Value: SBJ |
| Act.subject.contextControlCode | required | Fixed Value: OP |
| Act.subject.awarenessCode | extensible | TargetAwareness |
| Act.informant.typeCode | required | Fixed Value: INF |
| Act.informant.contextControlCode | required | Fixed Value: OP |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32030 | warning | Act.code | This code in a Planned Act **SHOULD** be selected from LOINC (CodeSystem: 2.16.840.1.113883.6.1) *OR* SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-32030). : | |
| act-er-1 | error | Act.entryRelationship, Act.entryRelationship:priorityPreference, Act.entryRelationship:indication, Act.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CDAR2.Act
Summary
Mandatory: 9 elements (6 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change