Communication
A clinical or business level record of information being transmitted or shared; e.g. an alert that was sent to a responsible provider, a public health agency communication to a provider/reporter in response to a case report for a reportable condition.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/Communication| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/Communication/[id] |
| Vread | GET | /fhir/R5/Communication/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Communication/[id] |
| Patch | PATCH | /fhir/R5/Communication/[id] |
| Delete | DELETE | /fhir/R5/Communication/[id] |
| Create | POST | /fhir/R5/Communication |
| Search | GET | /fhir/R5/Communication?... |
| History | GET | /fhir/R5/Communication/[id]/_history |
| Type-history | GET | /fhir/R5/Communication/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | Unique identifier |
instantiatesCanonical | canonical | 0..* | Instantiates FHIR protocol or definition |
instantiatesUri | uri | 0..* | Instantiates external protocol or definition |
basedOn | Reference | 0..* | Request fulfilled by this communication |
partOf | Reference | 0..* | Part of referenced event (e.g. Communication, Procedure) |
inResponseTo | Reference | 0..* | Reply to |
status | code | 1..1 | preparation |
statusReason | CodeableConcept | 0..1 | Reason for current status |
category | CodeableConcept | 0..* | Message category |
priority | code | 0..1 | routine |
medium | CodeableConcept | 0..* | A channel of communication |
subject | Reference | 0..1 | Focus of message |
topic | CodeableConcept | 0..1 | Description of the purpose/content |
about | Reference | 0..* | Resources that pertain to this communication |
encounter | Reference | 0..1 | The Encounter during which this Communication was created |
sent | dateTime | 0..1 | When sent |
received | dateTime | 0..1 | When received |
recipient | Reference | 0..* | Who the information is shared with |
sender | Reference | 0..1 | Who shares the information |
reason | CodeableReference | 0..* | Indication for message |
payload | BackboneElement | 0..* | Message payload |
note | Annotation | 0..* | Comments made about the communication |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
based-on | reference | Request fulfilled by this communication |
category | token | Message category |
encounter | reference | Encounter related to the activity recorded in the AuditEvent |
identifier | token | Account number |
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 referenced event (e.g. Communication, Procedure) |
patient | reference | The entity that caused the expenses |
received | date | When received |
recipient | reference | Who the information is shared with |
sender | reference | Who shares the information |
sent | date | When sent |
status | token | preparation |
subject | reference | Focus of message |
topic | token | Description of the purpose/content |
Reference
- Official FHIR R5 spec:
Communication - Maturity: Trial Use 2 (FMM 2).