Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot
Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot
Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest | Version: 3.0.0-ballot | ||||
| Active as of 2026-11-10 | Computable Name: CPGCommunicationRequest | ||||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.40 | |||||
Recommendation for a specific communication with the patient or other participant as part of the delivery of a computable clinical practice guideline
This is an activity request profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | Not State | Unknown | |
| CommunicationRequest.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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 CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||
|---|---|---|---|---|---|---|---|---|
  CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
  id |
0..1 | id | Logical id of this artifact | |||||
 meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:instantiatesCaseFeature |
0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | |||||
| extension:caseFeatureType |
0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred | |||||
| extension:caseFeaturePertinence |
0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature | |||||
| extension:pertinenceRating |
0..1 | integer | CPG Pertinence Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating | |||||
| extension:pertinentTo |
0..1 | Reference() | CPG Pertinent To Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo | |||||
| extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |||||
| extension:instantiatesCanonical |
0..1 | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical | |||||
| extension:rationale |
0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | |||||
 extension:rating |
0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating | |||||
 Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| modifierExtension:intent |
0..1 | code | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. Constraints: ext-1 | |||||
| identifier |
0..* | Identifier | Unique identifier | |||||
 basedOn |
0..* | Reference(Resource) | Fulfills plan or proposal | |||||
| replaces |
0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | |||||
| groupIdentifier |
0..1 | Identifier | Composite request this is part of | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | |||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
| category |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | |||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action | |||||
| medium |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject |
0..1 | Reference(Patient | Group) | Focus of message | |||||
| about |
0..* | Reference(Resource) | Pertinent information | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
| payload |
0..* | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
  content[x] |
1..1 | Message part content | ||||||
 contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
 contentReference |
Reference(Resource) | |||||||
| occurrence[x] |
0..1 | When scheduled | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
0..1 | dateTime | When request transitioned to being actionable | |||||
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
| recipient |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| reasonCode |
0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | |||||
| note |
0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | Not State | Unknown | |
| CommunicationRequest.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.5 |
| CommunicationRequest.reasonCode | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.5 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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 CommunicationRequest
Summary
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | Not State | Unknown | |
| CommunicationRequest.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
Differential View
This structure is derived from CommunicationRequest
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:instantiatesCaseFeature |
0..1 | canonical(CPG Case Feature Definition) | CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | |||||
| extension:caseFeatureType |
0..1 | code | CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred | |||||
| extension:caseFeaturePertinence |
0..1 | code | CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature | |||||
| extension:pertinenceRating |
0..1 | integer | CPG Pertinence Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinenceRating | |||||
| extension:pertinentTo |
0..1 | Reference() | CPG Pertinent To Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinentTo | |||||
| extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |||||
| extension:instantiatesCanonical |
0..1 | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical | |||||
| extension:rationale |
0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | |||||
| extension:rating |
0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating | |||||
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| modifierExtension:intent |
0..1 | code | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. Constraints: ext-1 | |||||
| identifier |
0..* | Identifier | Unique identifier | |||||
| basedOn |
0..* | Reference(Resource) | Fulfills plan or proposal | |||||
| replaces |
0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | |||||
| groupIdentifier |
0..1 | Identifier | Composite request this is part of | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | |||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
| category |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | |||||
| doNotPerform |
0..1 | boolean | True if request is prohibiting action | |||||
| medium |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject |
0..1 | Reference(Patient | Group) | Focus of message | |||||
| about |
0..* | Reference(Resource) | Pertinent information | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
| payload |
0..* | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| content[x] |
1..1 | Message part content | ||||||
| contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| occurrence[x] |
0..1 | When scheduled | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
0..1 | dateTime | When request transitioned to being actionable | |||||
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
| recipient |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| reasonCode |
0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | |||||
| note |
0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | Not State | Unknown | |
| CommunicationRequest.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| CommunicationRequest.medium | Base | example | ParticipationMode | 📦3.0.0 | THO v7.5 |
| CommunicationRequest.reasonCode | Base | example | v3 Code System ActReason | 📦3.0.0 | THO v7.5 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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 CommunicationRequest
Summary
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support.
Package hl7.fhir.uv.cpg#3.0.0-ballot based on FHIR 4.0.1.
Generated
2026-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
