Get a list of Communications
GET {{baseUrl}}/api/v2/Communication?patient=<integer>&category=<string>&departmentId=<integer>&_count=<integer>&_offset=<integer>&include=<string>
Overview:
Retrieves detailed information on communication events, allowing healthcare developers to access and display real-time data regarding interactions and messages for streamlined communication management within clinical workflows.
This is only supported in ATHENA.
Use Cases:
Review Message History: Retrieve all communications
Care Plan Information: Get care plan messages
Visit Prep: Obtain pre-visit
Care Team Coordination: Download for integrated care
Patient Relationship Management: Access engagement summary
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the communication. | |
category | string | The category of the communication | |
departmentId | string | The department identifier | |
_count | string | Number of results to return | |
_offset | string | Offset for paginated results | |
include | string | Fields to include in the response |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","total":"\u003cinteger\u003e","type":"\u003cstring\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","identifier":[{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"category":[{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}],"topic":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"status":"\u003cstring\u003e","payload":[{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]},{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","identifier":[{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"category":[{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}],"topic":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"status":"\u003cstring\u003e","payload":[{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]},{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]}]}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","total":"\u003cinteger\u003e","type":"\u003cstring\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","identifier":[{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"category":[{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}],"topic":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"status":"\u003cstring\u003e","payload":[{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]},{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","identifier":[{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"category":[{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}],"topic":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"status":"\u003cstring\u003e","payload":[{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]},{"contentString":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e","valueReference":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"display":"\u003cstring\u003e"}}]}]}}]}}]