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
| 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 |
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 this action |
inResponseTo | Reference | 0..* | Reply to |
status | code | 1..1 | preparation | in-progress | not-done | on-hold | stopped | 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 |
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 | Encounter created as part of |
sent | dateTime | 0..1 | When sent |
received | dateTime | 0..1 | When received |
recipient | Reference | 0..* | Message recipient |
sender | Reference | 0..1 | Message sender |
reasonCode | CodeableConcept | 0..* | Indication for message |
reasonReference | Reference | 0..* | Why was communication done? |
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 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
Official FHIR R4 spec: Communication.
Maturity: Trial Use 2 (FMM 2).