# CommunicationRequest

Canonical page: https://docs.ovok.com/api/fhir/r4/communication-request

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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Unique identifier |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | Fulfills plan or proposal |
| <span id="element-replaces"></span>`replaces` | [Reference](/fhir-elements/complex/reference) | `0..*` | Request(s) replaced by this request |
| <span id="element-group-identifier"></span>`groupIdentifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | Composite request this is part of |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown |
| <span id="element-status-reason"></span>`statusReason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Reason for current status |
| <span id="element-category"></span>`category` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Message category |
| <span id="element-priority"></span>`priority` | [code](/fhir-elements/primitive/code) | `0..1` | routine \| urgent \| asap \| stat |
| <span id="element-do-not-perform"></span>`doNotPerform` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | True if request is prohibiting action |
| <span id="element-medium"></span>`medium` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | A channel of communication |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..1` | Focus of message |
| <span id="element-about"></span>`about` | [Reference](/fhir-elements/complex/reference) | `0..*` | Resources that pertain to this communication request |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Encounter created as part of |
| <span id="element-payload"></span>`payload` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Message payload |
| <span id="element-occurrence-x"></span>`occurrence[x]` | [dateTime](/fhir-elements/primitive/date-time), [Period](/fhir-elements/complex/period) | `0..1` | When scheduled |
| <span id="element-authored-on"></span>`authoredOn` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When request transitioned to being actionable |
| <span id="element-requester"></span>`requester` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who/what is requesting service |
| <span id="element-recipient"></span>`recipient` | [Reference](/fhir-elements/complex/reference) | `0..*` | Message recipient |
| <span id="element-sender"></span>`sender` | [Reference](/fhir-elements/complex/reference) | `0..1` | Message sender |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Why is communication needed? |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Why is communication needed? |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Comments made about communication request |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [CommunicationRequest](https://hl7.org/fhir/R4/communicationrequest.html).  
Maturity: Trial Use 2 (FMM 2).
