CommunicationRequest
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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/CommunicationRequest/[id] |
| Vread | GET | /fhir/R4/CommunicationRequest/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/CommunicationRequest/[id] |
| Patch | PATCH | /fhir/R4/CommunicationRequest/[id] |
| Delete | DELETE | /fhir/R4/CommunicationRequest/[id] |
| Create | POST | /fhir/R4/CommunicationRequest |
| Search | GET | /fhir/R4/CommunicationRequest |
| History | GET | /fhir/R4/CommunicationRequest/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Unique identifier |
basedOn | Reference | 0..* | Fulfills plan or proposal |
replaces | Reference | 0..* | Request(s) replaced by this request |
groupIdentifier | Identifier | 0..1 | Composite request this is part of |
status | code | 1..1 | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
statusReason | CodeableConcept | 0..1 | Reason for current status |
category | CodeableConcept | 0..* | Message category |
priority | code | 0..1 | routine | urgent | asap | stat |
doNotPerform | boolean | 0..1 | True if request is prohibiting action |
medium | CodeableConcept | 0..* | A channel of communication |
subject | Reference | 0..1 | Focus of message |
about | Reference | 0..* | Resources that pertain to this communication request |
encounter | Reference | 0..1 | Encounter created as part of |
payload | BackboneElement | 0..* | Message payload |
occurrence[x] | dateTime, Period | 0..1 | When scheduled |
authoredOn | dateTime | 0..1 | When request transitioned to being actionable |
requester | Reference | 0..1 | Who/what is requesting service |
recipient | Reference | 0..* | Message recipient |
sender | Reference | 0..1 | Message sender |
reasonCode | CodeableConcept | 0..* | Why is communication needed? |
reasonReference | Reference | 0..* | Why is communication needed? |
note | Annotation | 0..* | Comments made about communication request |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
authored | date | When request transitioned to being actionable |
based-on | reference | Fulfills plan or proposal |
category | token | Message category |
encounter | reference | Encounter created as part of |
group-identifier | token | Composite request this is part of |
identifier | token | Unique identifier |
medium | token | A channel of communication |
occurrence | date | When scheduled |
patient | reference | Focus of message |
priority | token | routine | urgent | asap | stat |
recipient | reference | Message recipient |
replaces | reference | Request(s) replaced by this request |
requester | reference | Who/what is requesting service |
sender | reference | Message sender |
status | token | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
subject | reference | Focus of message |
Reference
Official FHIR R4 spec: CommunicationRequest.
Maturity: Trial Use 2 (FMM 2).