Path | Short | Definition | Comments |
---|---|---|---|
A request for information to be sent to a receiver | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition. | ||
identifier | Unique identifier | Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
basedOn | Fulfills plan or proposal | A plan or proposal that is fulfilled in whole or in part by this request. | |
replaces | Request(s) replaced by this request | Completed or terminated request(s) whose function is taken by this new request. | The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. |
groupIdentifier | Composite request this is part of | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
status | draft | active | suspended | cancelled | completed | entered-in-error | unknown | The status of the proposal or order. | |
statusReason | Reason for current status | Captures the reason for the current state of the CommunicationRequest. | This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings]. |
category | Message category | The type of message to be sent such as alert, notification, reminder, instruction, etc. | There may be multiple axes of categorization and one communication request may serve multiple purposes. |
priority | Message urgency | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. | |
doNotPerform | True if request is prohibiting action | If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. | The attributes provided with the request qualify what is not to be done. |
medium | A channel of communication | A channel that was used for this communication (e.g. email, fax). | |
subject | Focus of message | The patient or group that is the focus of this communication request. | |
about | Resources that pertain to this communication request | Other resources that pertain to this communication request and to which this communication request should be associated. | Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces. |
encounter | Encounter created as part of | The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. |
payload | Message payload | Text, attachment(s), or resource(s) to be communicated to the recipient. | |
payload.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
payload.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
payload.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
payload.content[x] | Message part content | The communicated content (or for multi-part communications, one portion of the communication). | |
occurrence[x] | When scheduled | The time when this communication is to occur. | |
authoredOn | When request transitioned to being actionable | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. | |
requester | Who/what is requesting service | The device, individual, or organization who initiated the request and has responsibility for its activation. | |
recipient | Message recipient | The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. | |
sender | Message sender | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | |
reasonCode | Why is communication needed? | Describes why the request is being made in coded or textual form. | Textual reasons can be captured using reasonCode.text. |
reasonReference | Why is communication needed? | Indicates another resource whose existence justifies this request. | |
note | Comments made about communication request | Comments made about the request by the requester, sender, recipient, subject or other participants. |
CommunicationRequest is one of the request resources in the FHIR workflow specification.
This resource is a record of a request for a communication to be performed. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The requester requests the sender to send the payload to the recipient. The sender and receivers may be patients, practitioners, related persons, organizations, and devices. Uses of communication request include:
This resource is a record of a request. It does not represent the actual flow of communication.
The use of CommunicationRequest excludes requests for referrals and requests for therapy or counseling which would be handled by the ServiceRequest resource. The performance of a CommunicationRequest may result in a Communication resource.
Notes to reviewers:
At this time, the code bindings are placeholders to be fleshed out upon further review by the community.
CommunicationRequest.sender allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService and CommunicationRequest.recipient allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService - but it is not unusual to have a communication target - even a defined one - where it is unknown what kind of role the person is playing.
If the communication request is to or from an individual, whose role is not known (practitioner, patient or related person), - for example, only email address is captured in the system; then RelatedPerson should be used by default.
authored | When request transitioned to being actionable | CommunicationRequest.authoredOn |
based-on | Fulfills plan or proposal | CommunicationRequest.basedOn |
category | Message category | CommunicationRequest.category |
encounter | Encounter created as part of | CommunicationRequest.encounter |
group-identifier | Composite request this is part of | CommunicationRequest.groupIdentifier |
identifier | Unique identifier | CommunicationRequest.identifier |
medium | A channel of communication | CommunicationRequest.medium |
occurrence | When scheduled | (CommunicationRequest.occurrence as dateTime) |
patient | Focus of message | CommunicationRequest.subject.where(resolve() is Patient) |
priority | Message urgency | CommunicationRequest.priority |
recipient | Message recipient | CommunicationRequest.recipient |
replaces | Request(s) replaced by this request | CommunicationRequest.replaces |
requester | Who/what is requesting service | CommunicationRequest.requester |
sender | Message sender | CommunicationRequest.sender |
status | draft | active | suspended | cancelled | completed | entered-in-error | unknown | CommunicationRequest.status |
subject | Focus of message | CommunicationRequest.subject |