FHIR Clinical Guidelines (v1.0.0) (STU1)
This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest
Recommendation for a specific communication with the patient or other participant as part of the delivery of a computable clinical practice guideline
This profile builds on CommunicationRequest.
This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
  id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 workflow-instantiatesCanonical | S | 0..1 | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
| cpg-rationale | S | 0..1 | markdown | Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 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 | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
| statusReason | S | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. |
| category | S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. |
| priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. |
| doNotPerform | ?!SΣ | 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 | S | 0..1 | Reference(Patient | Group) | Focus of message |
| about | S | 0..* | Reference(Resource) | Pertinent information |
| encounter | SΣ | 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 | SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| recipient | S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
| sender | SΣ | 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 | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| workflow-instantiatesCanonical | S | 0..1 | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
| cpg-rationale | S | 0..1 | markdown | Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 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 | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
| statusReason | S | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. |
| category | S | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. |
| priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. |
| doNotPerform | ?!SΣ | 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 | S | 0..1 | Reference(Patient | Group) | Focus of message |
| about | S | 0..* | Reference(Resource) | Pertinent information |
| encounter | SΣ | 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 | SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| recipient | S | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient |
| sender | SΣ | 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 | Conformance | ValueSet |
| CommunicationRequest.language | preferred | CommonLanguages Max Binding: AllLanguages |
| CommunicationRequest.status | required | RequestStatus |
| CommunicationRequest.statusReason | example | |
| CommunicationRequest.category | example | CommunicationCategory |
| CommunicationRequest.priority | required | RequestPriority |
| CommunicationRequest.medium | example | ParticipationMode |
| CommunicationRequest.reasonCode | example | v3.ActReason |
| Id | Path | Details | Requirements |
| dom-2 | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | CommunicationRequest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.extension:instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.extension:instantiatesCanonical | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.extension:rationale | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.extension:rationale | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.replaces | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.groupIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.doNotPerform | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.medium | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.about | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.payload | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.payload.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.payload.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.payload.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CommunicationRequest.payload.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CommunicationRequest.payload.content[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.authoredOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.requester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.recipient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CommunicationRequest.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org (Clinical Decision Support WG). hl7.fhir.uv.cpg#1.0.0 based on FHIR v4.0.1. Generated 2021-02-11.
Links: Home
| QA Report
| Version History
| 
| Propose a change
