Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.44 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: PlannedObservation | |||
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.44:2014-06-09 |
This template represents planned observations that result in new information about the patient which cannot be classified as a procedure according to the HL7 RIM, i.e., procedures alter the patient’s body. Examples of these observations are laboratory tests, diagnostic imaging tests, EEGs, and EKGs.
The importance of the planned observation to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the observation is intended to take place and authorTime indicates when the documentation of the plan occurred. The Planned Observation template may also indicate the potential insurance coverage for the observation.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Observation
Summary
Mandatory: 9 elements (8 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | ||
classCode | 1..1 | code | Required Pattern: OBS | |
moodCode | 1..1 | code | Binding: Planned moodCode (Observation) (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.44 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned observation represents the time that the observation should occur. | |
value | 0..1 | BL, ED, ED, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | ||
methodCode | 0..1 | CE | In a planned observation the provider may suggest that an observation should be performed using a particular method. | |
targetSiteCode | 0..* | CD | The targetSiteCode is used to identify the part of the body of concern for the planned observation. Binding: Body Site Value Set (required) | |
performer | 0..* | Performer2 | The clinician who is expected to perform the observation could be identified using procedure/performer. | |
author | 0..* | AuthorParticipation | The author in a planned observation represents the clinician who is requesting or planning the observation. | |
Slices for entryRelationship | 0..* | Element | The following entryRelationship represents the insurance coverage the patient may have for the observation. Slice: Unordered, Open by profile:observation, profile:act | |
entryRelationship:priorityPreference | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the observation. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the observation. | |
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..* | Element | The following entryRelationship captures any instructions associated with the planned observation. | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
act | 1..1 | Instruction | ||
entryRelationship:plannedCoverage | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: COMP | |
act | 1..1 | PlannedCoverage | ||
Documentation for this format |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 9 elements (8 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.Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | ||
classCode | 1..1 | code | Required Pattern: OBS | |
moodCode | 1..1 | code | Binding: Planned moodCode (Observation) (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.44 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned observation represents the time that the observation should occur. | |
value | 0..1 | BL, ED, ED, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | ||
methodCode | 0..1 | CE | In a planned observation the provider may suggest that an observation should be performed using a particular method. | |
targetSiteCode | 0..* | CD | The targetSiteCode is used to identify the part of the body of concern for the planned observation. Binding: Body Site Value Set (required) | |
performer | 0..* | Performer2 | The clinician who is expected to perform the observation could be identified using procedure/performer. | |
author | 0..* | AuthorParticipation | The author in a planned observation represents the clinician who is requesting or planning the observation. | |
Slices for entryRelationship | 0..* | Element | The following entryRelationship represents the insurance coverage the patient may have for the observation. Slice: Unordered, Open by profile:observation, profile:act | |
entryRelationship:priorityPreference | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the observation. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the observation. | |
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..* | Element | The following entryRelationship captures any instructions associated with the planned observation. | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
act | 1..1 | Instruction | ||
entryRelationship:plannedCoverage | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: COMP | |
act | 1..1 | PlannedCoverage | ||
Documentation for this format |
Snapshot View
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: OBS |
Observation.moodCode | required | Planned moodCode (Observation) |
Observation.templateId:primary.nullFlavor | required | NullFlavor |
Observation.code | extensible | ObservationType |
Observation.statusCode | required | ActStatus |
Observation.statusCode.nullFlavor | required | NullFlavor |
Observation.priorityCode | extensible | ActPriority |
Observation.languageCode | required | HumanLanguage |
Observation.interpretationCode | required | ObservationInterpretation |
Observation.methodCode | extensible | ObservationMethod |
Observation.targetSiteCode | required | BodySiteValueSet |
Observation.subject.typeCode | required | Fixed Value: SBJ |
Observation.subject.contextControlCode | required | Fixed Value: OP |
Observation.subject.awarenessCode | extensible | TargetAwareness |
Observation.informant.typeCode | required | Fixed Value: INF |
Observation.informant.contextControlCode | required | Fixed Value: OP |
Observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path | Details | Requirements |
obs-er-1 | error | Observation.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
obs-er-1 | error | Observation.entryRelationship:priorityPreference | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
obs-er-1 | error | Observation.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
obs-er-1 | error | Observation.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 | |
obs-er-1 | error | Observation.entryRelationship:plannedCoverage | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |