Communication
Overview
The Communication resource is a conveyance of information from one entity, a sender, to another entity, a receiver. The information includes encoded data and optionally a related Patient and a related Encounter.
The following fields are returned if valued:
- Communication Id
- In Response To
- Status (Completed)
- Category
- Priority
- Subject
- Topic
- Encounter
- Sent DateTime
- Received DateTime
- Recipient
- Sender
- Payload
Terminology Bindings
Communication.category |
|
Communication.email-status |
|
Extensions
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
ID | Value[x] Type | Description |
---|---|---|
reply-to |
Reference |
Used to direct where replies to the communication should be sent. Must be a Group. |
email-status |
CodeableConcept |
Status of the electronic communication (in-progress, completed, received). |
Search
Search for communications that meet supplied query parameters:
GET /Communication?:parameters
Implementation Notes
- The Content of a communication will be returned through the binary resource. A reference to the payload will be provided in the Payload section.
- Only 1000 elements max will be returned based on the date range.
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
This or (category , -email-status , recipient and received ) |
token |
The logical resource id associated with the resource. Example: 489580643.0.-4.prsnl
|
category |
(This, recipient , received and -email-status ) or _id
|
token |
A token for a CodeableConcept that points to the CodeableConcept used for Communication.category. Example: http://terminology.hl7.org/CodeSystem/communication-category|notification
|
recipient |
(This, category , received and -email-status ) or _id
|
reference |
The recipient of the communication. Example: Practitioner/3456783
|
received |
(This, category , recipient and -email-status ) or _id
|
date |
Date range into which the communication falls. Example: le2017-02-01T10:30:00Z
|
-email-status |
(This, category , recipient and received ) or _id
|
token |
The status of the email. Example: http://hl7.org/fhir/task-status|in-progress
|
Notes:
- The
recipient
parameter must represent a Practitioner or a Group. - The
received
parameter may be provided:- once with the
ge
prefix. - twice with the lower value prefixed by
ge
and the higher value prefixed byle
.
- once with the
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication?_id=489580643.0.-4.prsnl
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "e989e20d-5cfc-4b11-ab43-95ba1a684063",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication?_id=489580643.0.-4.prsnl"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication/489580643.0.-4.prsnl",
"resource": {
"resourceType": "Communication",
"id": "489580643.0.-4.prsnl",
"meta": {
"versionId": "0",
"lastUpdated": "2020-07-16T21:31:35.457Z"
},
"text": {
"status": "generated",
"div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Communication</b></p></div>"
},
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/task-status",
"code": "completed",
"display": "Completed"
}
],
"text": "Completed"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status"
}
],
"inResponseTo": [
{
"reference": "Communication/512657279.0.-4.prsnl"
}
],
"status": "completed",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/communication-category",
"code": "notification",
"display": "Notification"
}
],
"text": "Notification"
}
],
"priority": "urgent",
"subject": {
"reference": "Patient/12505984",
"display": "JOHNSON, MARIE"
},
"topic": {
"text": "CDI Query"
},
"encounter": {
"reference": "Encounter/97739401"
},
"sent": "2020-07-16T21:31:35.457Z",
"received": "2020-07-16T21:31:35.457Z",
"recipient": [
{
"reference": "Practitioner/12093978",
"display": "Stone, RN, Sally Cerner"
},
{
"reference": "Group/1568",
"display": "HEALTHE Receiver Group"
}
],
"sender": {
"reference": "Practitioner/11875977",
"display": "Stratford, Angela Cerner"
},
"payload": [
{
"contentReference": {
"reference": "Binary/489580643.0.-4.prsnl"
}
}
]
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by id
List an individual communication by its id:
GET /Communication/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication/489580643.0.-4.prsnl
Response
Status: 200 OK
{
"resourceType": "Communication",
"id": "489580643.0.-4.prsnl",
"meta": {
"versionId": "0",
"lastUpdated": "2020-07-16T21:31:35.457Z"
},
"text": {
"status": "generated",
"div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Communication</b></p></div>"
},
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/task-status",
"code": "completed",
"display": "Completed"
}
],
"text": "Completed"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status"
}
],
"inResponseTo": [
{
"reference": "Communication/512657279.0.-4.prsnl"
}
],
"status": "completed",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/communication-category",
"code": "notification",
"display": "Notification"
}
],
"text": "Notification"
}
],
"priority": "urgent",
"subject": {
"reference": "Patient/12505984",
"display": "JOHNSON, MARIE"
},
"topic": {
"text": "CDI Query"
},
"encounter": {
"reference": "Encounter/97739401"
},
"sent": "2020-07-16T21:31:35.457Z",
"received": "2020-07-16T21:31:35.457Z",
"recipient": [
{
"reference": "Practitioner/12093978",
"display": "Stone, RN, Sally Cerner"
},
{
"reference": "Group/1568",
"display": "HEALTHE Receiver Group"
}
],
"sender": {
"reference": "Practitioner/11875977",
"display": "Stratford, Angela Cerner"
},
"payload": [
{
"contentReference": {
"reference": "Binary/489580643.0.-4.prsnl"
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Create
Create a new communication.
POST /Communication
Implementation Notes
- Only the body fields mentioned below are supported. Unsupported fields will be ignored.
- Modifier fields should not be provided, and will cause the transaction to fail.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
status
|
Yes |
code |
|
|
|||
category
|
Yes |
CodeableConcept |
|
|
|||
priority
|
No |
code |
|
|
|||
subject
|
No |
Reference (Patient ) |
|
|
|||
topic
|
No |
code |
|
|
|||
encounter
|
No |
Reference (Encounter ) |
|
|
|||
recipient
|
Yes |
Reference (Practitioner , Group ) |
|
|
|||
sender
|
Yes |
Reference (Practitioner ) |
|
|
|||
payload
|
Yes |
BackboneElement |
|
|
|||
reply-to
|
No |
Reference (Group ) |
|
|
Example
Request
POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication
Body
{
"resourceType": "Communication",
"extension": [
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to",
"valueReference": {
"reference": "Group/6345478364"
}
}
],
"status": "completed",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/communication-category",
"code": "reminder"
}
]
}
],
"priority": "urgent",
"subject": {
"reference": "Patient/12457978"
},
"topic": {
"text": "CDI Query"
},
"encounter": {
"reference": "Encounter/97697401"
},
"recipient": [
{
"reference": "Practitioner/744113"
},
{
"reference": "Group/6345478364"
}
],
"sender": {
"reference": "Practitioner/593923"
},
"payload": [
{
"contentAttachment": {
"contentType": "text/plain",
"data": "Q29tbXVuaWNhdGlvbg=="
}
}
]
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: application/json Date: Tue, 04 Aug 2020 17:59:03 GMT Etag: W/"0" Location: https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication/472894781.0.-4.0 Last-Modified: Tue, 04 Aug 2020 17:59:03 GMT Server-Response-Time: 22.810143 Status: 201 Created Vary: Origin X-Request-Id: b89310ef-51ef-4b76-b92e-d070496c999c X-Runtime: 0.022706
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Patch
Patch an existing communication.
PATCH /Communication/:id
Implementation Notes
- This implementation follows the JSON PATCH spec.
- Only operations on the paths listed below are supported.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/json-patch+json
If-Match: W/"<Current version of the Communication resource>"
Patch Operations
Path | Operation | Value Type | |
---|---|---|---|
/extension
|
replace |
Extension |
|
|
Example
Request
PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication/123
Body
[
{
"path": "/extension",
"op": "replace",
"value": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/task-status",
"code": "completed"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status"
}
]
}
]
Response
Status: 200 OK
Cache-Control: no-cache Content-Length: 0 Content-Type: application/json Date: Wed, 11 Nov 2020 18:42:40 GMT Etag: W/"2" Last-Modified: Wed, 11 Nov 2020 18:42:40 GMT Server-Response-Time: 826.746885 Status: 200 OK Vary: Origin X-Request-Id: 1594889a-8278-43f2-9c83-d84d6d2b3c72 X-Runtime: 0.826616
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.