Communication read

get/Communication/{id}

Page View

Show Required Fields Only

Show Translation Fields

This resource contains messages, notifications, and alerts sent to patients or other parties. Each communication entry contains the content, sender, recipient, status, and date information.

You can review or retrieve communications with FHIR® passthrough.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific Communication resource with message details, sender, recipient, and status for a given patient or contact.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Communication/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
Communication identifier

Response fields and example

Example Communication

json

1
{}

A profile on the Communication resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: Communication
status
required, string
The status of the transmission.
Possible Values: preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, unknown
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
Array of object
Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- extension
  Array of Boolean, String, CodeableConcept, Coding
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  One of:
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  valueBoolean
  boolean
  A single value for the extension.
- use
  string
  The purpose of this identifier.
  Possible Values: usual, official, temp, secondary, old (If known)
- system
  string
  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- value
  string
  The portion of the identifier typically relevant to the user and which is unique within the context of the system.
category
Array of object
The type of message conveyed such as alert, notification, reminder, instruction, etc.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
subject
object
The patient or group that was the focus of this communication.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
topic
object
Description of the purpose/content, similar to a subject line in an email.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
encounter
object
The Encounter during which this Communication was created or to which the creation of this record is tightly associated.

Must be a resource of type Encounter.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
sent
string
The time when this communication was sent.
received
string
The time when this communication arrived at the destination.
recipient
Array of object
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).

Must reference one of the following types of resources:
- Device
- Organization
- Patient
- Practitioner
- PractitionerRole
- RelatedPerson
- Group
- CareTeam
- HealthcareService
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
sender
object
The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

Must reference one of the following types of resources:
- Device
- Organization
- Patient
- Practitioner
- PractitionerRole
- RelatedPerson
- HealthcareService
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
payload
Array of object
Text, attachment(s), or resource(s) that was communicated to the recipient.
- contentString
  required, string
  A communicated content (or for multi-part communications, one portion of the communication).
  
  Only one of contentString, contentAttachment may be present.
- contentAttachment
  required, object
  A communicated content (or for multi-part communications, one portion of the communication).
  
  Only one of contentString, contentAttachment may be present.
  contentType
  string
  Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
  data
  string
  The actual data of the attachment - a sequence of bytes, base64 encoded.
  creation
  string
  The date that the attachment was first created.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.