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/CareExperiencePreference | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: CareExperiencePreference | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.509:2024-05-01 | ||||
This Care Experience Preference template represents a person’s care preferences during their care and treatment. Examples include, but are not limited to religious preferences, dislikes and fears, and thoughts and feelings to be shared. This templates does not represent actual order, but holds observations about wishes. These observations may inform the placement of future orders. While observation.code is encoded to support system queries, the answers represented at observation.value are likely to be text. Precondition.Criterion is recommended to represent the situations when a person would prefer the stated care experiences, such as during childbirth or interventional procedures. This template may be used directly in any section, such as Care Plan Document Sections, Social History, or Advance Directives, and may be used inside any entry such as Procedure or Medication Activity.
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-sdtcPrecondition2: SHOULD contain sdtc:Precondition2 |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:care-experience-pref | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.509 | |
  @extension | 1..1 | st | Required Pattern: 2024-05-01 | |
 @classCode | 1..1 | cs | Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: INT | |
| id | 1..* | II | ||
| code | 1..1 | CD | Care Experience Preference | |
| @code | 1..1 | cs | Required Pattern: 95541-9 | |
 @codeSystem | 1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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 |
 value | 1..1 | Most of the time, the value will be a string representing the person's words. | ||
 value | ED | |||
| value | CD | |||
| sdtcPrecondition2 | C | 0..* | Precondition2 | should-criterion: SHOULD contain criterion |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| should-criterion | warning | Observation.sdtcPrecondition2 | SHOULD contain criterion : criterion.exists() | |
| should-sdtcPrecondition2 | warning | Observation | SHOULD contain sdtc:Precondition2 : sdtcPrecondition2.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-sdtcPrecondition2: SHOULD contain sdtc:Precondition2 |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-experience-pref | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.509 | |
| @extension | 1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: INT | |
 id | 1..* | II | ||
| code | 1..1 | CD | Care Experience Preference Binding: ObservationType (example) | |
| @code | 1..1 | cs | Required Pattern: 95541-9 | |
| @codeSystem | 1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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 |
| value | 1..1 | Most of the time, the value will be a string representing the person's words. | ||
| value | ED | |||
| value | CD | |||
| sdtcPrecondition2 | C | 0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) should-criterion: SHOULD contain criterion |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: INT |
| Observation.code | example | ObservationType |
| Id | Grade | Path(s) | Details | Requirements |
| should-criterion | warning | Observation.sdtcPrecondition2 | SHOULD contain criterion : criterion.exists() | |
| should-sdtcPrecondition2 | warning | Observation | SHOULD contain sdtc:Precondition2 : sdtcPrecondition2.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('#') |
| Path | Conformance | ValueSet / Code |
| Observation.nullFlavor | required | CDANullFlavor |
| Observation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.templateId:care-experience-pref.nullFlavor | required | CDANullFlavor |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: INT |
| Observation.code | example | ObservationType |
| Observation.code.nullFlavor | required | CDANullFlavor |
| 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.priorityCode | example | ActPriority |
| Observation.languageCode | required | AllLanguages |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | example | ObservationMethod |
| 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-criterion | warning | Observation.sdtcPrecondition2 | SHOULD contain criterion : criterion.exists() | |
| should-sdtcPrecondition2 | warning | Observation | SHOULD contain sdtc:Precondition2 : sdtcPrecondition2.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('#') |
This structure is derived from Observation
Summary
Mandatory: 8 elements
Fixed Value: 2 elements
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-sdtcPrecondition2: SHOULD contain sdtc:Precondition2 |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-experience-pref | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.509 | |
| @extension | 1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode | 1..1 | cs | Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: INT | |
| id | 1..* | II | ||
| code | 1..1 | CD | Care Experience Preference | |
| @code | 1..1 | cs | Required Pattern: 95541-9 | |
| @codeSystem | 1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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 |
| value | 1..1 | Most of the time, the value will be a string representing the person's words. | ||
| value | ED | |||
| value | CD | |||
| sdtcPrecondition2 | C | 0..* | Precondition2 | should-criterion: SHOULD contain criterion |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| should-criterion | warning | Observation.sdtcPrecondition2 | SHOULD contain criterion : criterion.exists() | |
| should-sdtcPrecondition2 | warning | Observation | SHOULD contain sdtc:Precondition2 : sdtcPrecondition2.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-sdtcPrecondition2: SHOULD contain sdtc:Precondition2 |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:care-experience-pref | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.509 | |
| @extension | 1..1 | st | Required Pattern: 2024-05-01 | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (2.0.0) (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: INT | |
| id | 1..* | II | ||
| code | 1..1 | CD | Care Experience Preference Binding: ObservationType (example) | |
| @code | 1..1 | cs | Required Pattern: 95541-9 | |
| @codeSystem | 1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
| 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 |
| value | 1..1 | Most of the time, the value will be a string representing the person's words. | ||
| value | ED | |||
| value | CD | |||
| sdtcPrecondition2 | C | 0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) should-criterion: SHOULD contain criterion |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: INT |
| Observation.code | example | ObservationType |
| Id | Grade | Path(s) | Details | Requirements |
| should-criterion | warning | Observation.sdtcPrecondition2 | SHOULD contain criterion : criterion.exists() | |
| should-sdtcPrecondition2 | warning | Observation | SHOULD contain sdtc:Precondition2 : sdtcPrecondition2.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('#') |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Observation.nullFlavor | required | CDANullFlavor |
| Observation.typeId.nullFlavor | required | CDANullFlavor |
| Observation.templateId:care-experience-pref.nullFlavor | required | CDANullFlavor |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.moodCode | required | Fixed Value: INT |
| Observation.code | example | ObservationType |
| Observation.code.nullFlavor | required | CDANullFlavor |
| 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.priorityCode | example | ActPriority |
| Observation.languageCode | required | AllLanguages |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | example | ObservationMethod |
| 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-criterion | warning | Observation.sdtcPrecondition2 | SHOULD contain criterion : criterion.exists() | |
| should-sdtcPrecondition2 | warning | Observation | SHOULD contain sdtc:Precondition2 : sdtcPrecondition2.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('#') |
This structure is derived from Observation
Summary
Mandatory: 8 elements
Fixed Value: 2 elements
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