This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PriorityPreference | Version: 3.0.0 | |||
| Draft as of 2024-05-18 | Computable Name: PriorityPreference | |||
| Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.143 | ||||
This template represents priority preferences chosen by a patient or a care provider. Priority preferences are choices made by care providers or patients or both relative to options for care or treatment (including scheduling, care experience, and meeting of personal health goals), the sharing and disclosure of health information, and the prioritization of concerns and problems.
Usage:
Description of Template, 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 Instance 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-author: SHOULD contain author | 
|    Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
|     templateId:priority-pref | 1..1 | II | ||
|      @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.143 | |
|      @extension | 0..0 | |||
|    @classCode | 1..1 | cs | Fixed Value: OBS | |
|    @moodCode | 1..1 | cs | Fixed Value: EVN | |
|    id | 1..* | II | ||
|    code | 1..1 | CD | ||
|     @code | 1..1 | cs | Required Pattern: 225773000 | |
|     @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
|    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 | 
|    effectiveTime | 0..1 | IVL_TS | ||
|    value | 1..1 | CD | Binding: Priority Level  (required) | |
|    author | 0..* | AuthorParticipation | Base for all types and resources | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Observation.value | required | PriorityLevel  http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.60 | 
| 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-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 Instance 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-author: SHOULD contain author | 
|    Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
|     templateId:priority-pref | 1..1 | II | ||
|      @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.143 | |
|    @classCode | 1..1 | cs | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
|    @moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
|    id | 1..* | II | ||
|    code | 1..1 | CD | Binding: ObservationType (example) | |
|     @code | 1..1 | cs | Required Pattern: 225773000 | |
|     @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
|    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 | 
|    effectiveTime | 0..1 | IVL_TS | ||
|    value | 1..1 | CD | Binding: Priority Level  (required) | |
|    author | 0..* | AuthorParticipation | Base for all types and resources | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Observation.classCode | required | Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.value | required | PriorityLevel  http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.60 | 
| 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-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 | URI | 
| Observation.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.typeId.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.templateId:priority-pref.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.classCode | required | Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.code.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.text.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.text.compression | required | CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Observation.text.mediaType | example | MediaType http://terminology.hl7.org/ValueSet/v3-MediaType | |
| Observation.text.representation | required | BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Observation.statusCode | required | ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Observation.priorityCode | example | ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Observation.languageCode | required | AllLanguages http://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Observation.value | required | PriorityLevel  http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.60 | |
| Observation.interpretationCode | required | CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
| Observation.methodCode | example | ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
| Observation.referenceRange.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType | 
| 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-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: 7 elements
 Fixed: 2 elements
 Prohibited: 1 element
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 Instance 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-author: SHOULD contain author | 
|    Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
|     templateId:priority-pref | 1..1 | II | ||
|      @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.143 | |
|      @extension | 0..0 | |||
|    @classCode | 1..1 | cs | Fixed Value: OBS | |
|    @moodCode | 1..1 | cs | Fixed Value: EVN | |
|    id | 1..* | II | ||
|    code | 1..1 | CD | ||
|     @code | 1..1 | cs | Required Pattern: 225773000 | |
|     @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
|    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 | 
|    effectiveTime | 0..1 | IVL_TS | ||
|    value | 1..1 | CD | Binding: Priority Level  (required) | |
|    author | 0..* | AuthorParticipation | Base for all types and resources | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Observation.value | required | PriorityLevel  http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.60 | 
| 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-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 Instance 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-author: SHOULD contain author | 
|    Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
|     templateId:priority-pref | 1..1 | II | ||
|      @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.143 | |
|    @classCode | 1..1 | cs | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
|    @moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
|    id | 1..* | II | ||
|    code | 1..1 | CD | Binding: ObservationType (example) | |
|     @code | 1..1 | cs | Required Pattern: 225773000 | |
|     @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
|    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 | 
|    effectiveTime | 0..1 | IVL_TS | ||
|    value | 1..1 | CD | Binding: Priority Level  (required) | |
|    author | 0..* | AuthorParticipation | Base for all types and resources | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Observation.classCode | required | Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.value | required | PriorityLevel  http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.60 | 
| 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-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 | URI | 
| Observation.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.typeId.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.templateId:priority-pref.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.classCode | required | Fixed Value: OBS http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
| Observation.moodCode | required | Fixed Value: EVN http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
| Observation.code | example | ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType | |
| Observation.code.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.text.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.text.compression | required | CDACompressionAlgorithm http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Observation.text.mediaType | example | MediaType http://terminology.hl7.org/ValueSet/v3-MediaType | |
| Observation.text.representation | required | BinaryDataEncoding http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Observation.statusCode | required | ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Observation.priorityCode | example | ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Observation.languageCode | required | AllLanguages http://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Observation.value | required | PriorityLevel  http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.60 | |
| Observation.interpretationCode | required | CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
| Observation.methodCode | example | ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
| Observation.referenceRange.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType | 
| 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-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: 7 elements
 Fixed: 2 elements
 Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: