Get Communication by ID
GET {{baseUrl}}/api/v2/Communication/:document-id?patient=<integer>
Overview:
Fetches specific communication details by ID, allowing targeted access to individual communication data for personalized analysis and retrieval within healthcare systems.
This is only supported in ATHENA.
Use Cases:
Review Message Details: Retrieve communication specifics
Care Team Information Check: Get details on care team message
Visit Summary Access: Obtain summarized visit communication
Notification Record Access: Get stored notification details
Screening System Retrieval: Access automated screening system message
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the communication. |
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","identifier":[{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"type":{"text":"\u003cstring\u003e"},"value":"\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"}}]}],"topic":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]}}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","identifier":[{"type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"type":{"text":"\u003cstring\u003e"},"value":"\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"}}]}],"topic":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]}}}]