Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) 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/PlannedObservation | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: PlannedObservation | |||
| Other Identifiers: id: 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 Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-author: SHOULD contain author |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:planned-obs | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.44 | |
  @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
 @classCode | 1..1 | cs | Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: Planned moodCode (Observation) (required) | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
 reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | ||
| @code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned observation represents the time that the observation should occur. | |
| value | 0..1 | ANY, BL, ED, ST, CD, CV, CE, CO, 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..* | EntryRelationship | 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..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the observation. | |
 @typeCode | 1..1 | cs | Fixed Value: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the observation. | |
| @typeCode | 1..1 | cs | Fixed Value: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned observation. | |
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Fixed Value: COMP | |
| act | 1..1 | PlannedCoverage | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.moodCode | required | PlannedMoodCodeObservation |
| Observation.targetSiteCode | required | BodySiteValueSet |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-targetSiteCode | warning | Observation | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-author: SHOULD contain author |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-obs | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.44 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: Planned moodCode (Observation) (required) | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (example) | |
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned observation represents the time that the observation should occur. | |
 value | 0..1 | |||
 value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | CO | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | 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. Binding: ObservationMethod (example) | |
| 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..* | EntryRelationship | 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..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the observation. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation | C | 1..1 | PriorityPreference | Base for all types and resources |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the observation. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| observation | C | 1..1 | Indication | Base for all types and resources |
| entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned observation. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| act | C | 1..1 | Instruction | Base for all types and resources |
| entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| act | C | 1..1 | PlannedCoverage | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | PlannedMoodCodeObservation |
| Observation.code | example | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.methodCode | example | ObservationMethod |
| Observation.targetSiteCode | required | BodySiteValueSet |
| Observation.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Observation.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Observation.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-author | warning | Observation.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-targetSiteCode | warning | Observation | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation, Observation.entryRelationship:instruction.act, Observation.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Path | Conformance | ValueSet / Code |
| Observation.nullFlavor | required | CDANullFlavor |
| Observation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.templateId:planned-obs.nullFlavor | required | CDANullFlavor |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | PlannedMoodCodeObservation |
| Observation.code | example | ObservationType |
| Observation.text.nullFlavor | required | CDANullFlavor |
| Observation.text.compression | required | CDACompressionAlgorithm |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Observation.text.mediaType | example | MediaType |
| Observation.text.representation | required | BinaryDataEncoding |
| Observation.statusCode | required | ActStatus |
| Observation.statusCode.nullFlavor | required | CDANullFlavor |
| Observation.priorityCode | example | ActPriority |
| Observation.languageCode | required | AllLanguages |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | example | ObservationMethod |
| Observation.targetSiteCode | required | BodySiteValueSet |
| Observation.entryRelationship:priorityPreference.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:priorityPreference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Observation.entryRelationship:indication.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:indication.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:instruction.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Observation.entryRelationship:plannedCoverage.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:plannedCoverage.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
| Observation.referenceRange.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-author | warning | Observation.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-targetSiteCode | warning | Observation | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation, Observation.entryRelationship:instruction.act, Observation.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Observation
Summary
Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-author: SHOULD contain author |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-obs | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.44 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: Planned moodCode (Observation) (required) | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | ||
| @code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned observation represents the time that the observation should occur. | |
| value | 0..1 | ANY, BL, ED, ST, CD, CV, CE, CO, 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..* | EntryRelationship | 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..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the observation. | |
| @typeCode | 1..1 | cs | Fixed Value: REFR | |
| observation | 1..1 | PriorityPreference | Base for all types and resources | |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the observation. | |
| @typeCode | 1..1 | cs | Fixed Value: RSON | |
| observation | 1..1 | Indication | Base for all types and resources | |
| entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned observation. | |
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| act | 1..1 | Instruction | Base for all types and resources | |
| entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Fixed Value: COMP | |
| act | 1..1 | PlannedCoverage | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.moodCode | required | PlannedMoodCodeObservation |
| Observation.targetSiteCode | required | BodySiteValueSet |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-targetSiteCode | warning | Observation | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-author: SHOULD contain author |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-obs | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.44 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: Planned moodCode (Observation) (required) | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (example) | |
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: active | |
| effectiveTime | 0..1 | IVL_TS | The effectiveTime in a planned observation represents the time that the observation should occur. | |
| value | 0..1 | |||
| value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | CO | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | 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. Binding: ObservationMethod (example) | |
| 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..* | EntryRelationship | 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..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the observation. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
| observation | C | 1..1 | PriorityPreference | Base for all types and resources |
| entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the observation. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| observation | C | 1..1 | Indication | Base for all types and resources |
| entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned observation. | |
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| act | C | 1..1 | Instruction | Base for all types and resources |
| entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| act | C | 1..1 | PlannedCoverage | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | PlannedMoodCodeObservation |
| Observation.code | example | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.methodCode | example | ObservationMethod |
| Observation.targetSiteCode | required | BodySiteValueSet |
| Observation.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Observation.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Observation.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-author | warning | Observation.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-targetSiteCode | warning | Observation | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation, Observation.entryRelationship:instruction.act, Observation.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Observation.nullFlavor | required | CDANullFlavor |
| Observation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.templateId:planned-obs.nullFlavor | required | CDANullFlavor |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | PlannedMoodCodeObservation |
| Observation.code | example | ObservationType |
| Observation.text.nullFlavor | required | CDANullFlavor |
| Observation.text.compression | required | CDACompressionAlgorithm |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Observation.text.mediaType | example | MediaType |
| Observation.text.representation | required | BinaryDataEncoding |
| Observation.statusCode | required | ActStatus |
| Observation.statusCode.nullFlavor | required | CDANullFlavor |
| Observation.priorityCode | example | ActPriority |
| Observation.languageCode | required | AllLanguages |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | example | ObservationMethod |
| Observation.targetSiteCode | required | BodySiteValueSet |
| Observation.entryRelationship:priorityPreference.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:priorityPreference.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
| Observation.entryRelationship:indication.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:indication.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:instruction.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
| Observation.entryRelationship:plannedCoverage.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:plannedCoverage.typeId.nullFlavor | required | CDANullFlavor |
| Observation.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
| Observation.referenceRange.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| should-author | warning | Observation | SHOULD contain author : author.exists() | |
| should-author | warning | Observation.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-targetSiteCode | warning | Observation | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Observation.entryRelationship:priorityPreference.observation, Observation.entryRelationship:indication.observation, Observation.entryRelationship:instruction.act, Observation.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Observation
Summary
Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 6 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#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change
