# Communication

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

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was 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/Communication/[id]` |
| Vread | `GET` | `/fhir/R4/Communication/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Communication/[id]` |
| Patch | `PATCH` | `/fhir/R4/Communication/[id]` |
| Delete | `DELETE` | `/fhir/R4/Communication/[id]` |
| Create | `POST` | `/fhir/R4/Communication` |
| Search | `GET` | `/fhir/R4/Communication` |
| History | `GET` | `/fhir/R4/Communication/[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-instantiates-canonical"></span>`instantiatesCanonical` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Instantiates FHIR protocol or definition |
| <span id="element-instantiates-uri"></span>`instantiatesUri` | [uri](/fhir-elements/primitive/uri) | `0..*` | Instantiates external protocol or definition |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | Request fulfilled by this communication |
| <span id="element-part-of"></span>`partOf` | [Reference](/fhir-elements/complex/reference) | `0..*` | Part of this action |
| <span id="element-in-response-to"></span>`inResponseTo` | [Reference](/fhir-elements/complex/reference) | `0..*` | Reply to |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | preparation \| in-progress \| not-done \| on-hold \| stopped \| 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-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-topic"></span>`topic` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Description of the purpose/content |
| <span id="element-about"></span>`about` | [Reference](/fhir-elements/complex/reference) | `0..*` | Resources that pertain to this communication |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Encounter created as part of |
| <span id="element-sent"></span>`sent` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When sent |
| <span id="element-received"></span>`received` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When received |
| <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..*` | Indication for message |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Why was communication done? |
| <span id="element-payload"></span>`payload` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Message payload |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Comments made about the communication |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `based-on` | reference | Request fulfilled by this communication |
| `category` | token | Message category |
| `encounter` | reference | Encounter created as part of |
| `identifier` | token | Unique identifier |
| `instantiates-canonical` | reference | Instantiates FHIR protocol or definition |
| `instantiates-uri` | uri | Instantiates external protocol or definition |
| `medium` | token | A channel of communication |
| `part-of` | reference | Part of this action |
| `patient` | reference | Focus of message |
| `received` | date | When received |
| `recipient` | reference | Message recipient |
| `sender` | reference | Message sender |
| `sent` | date | When sent |
| `status` | token | preparation \| in-progress \| not-done \| on-hold \| stopped \| completed \| entered-in-error \| unknown |
| `subject` | reference | Focus of message |

## Reference [#reference]

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