Communication
Automatic sharing
This resource is automatically shared with all users referenced in Communication.recipient and Communication.sender.
Semantical type
The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name Communication into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a subject which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “subject”
If a resource with no subject field is send to MIDATA, the backend will set the subject to the current user.
Read
Read a single Communication by id.
Request:
[GET] /fhir/Communication/<id>
Read specific version
Read a specific version of a single Communication by id.
Request:
[GET] /fhir/Communication/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Communication/<id>/_history
Search
Search for resources of type Communication
Request:
[GET] /fhir/Communication?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | string | The resource identity |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| 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 - suspended - aborted - completed - entered-in-error |
| subject | reference | Focus of message |
Create
Create a new resource of type Communication.
Request:
[POST] /fhir/Communication
Update
Updates a resource of type Communication.
Request:
[PUT] /fhir/Communication/<id>