Send inbasket message

Send inbasket message to Epic

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

hls-inbasket-message:write

Body Params
string
length between 1 and 2147483647

The identifier for the reason for contact (e.g., appointment ID, order ID, etc.)

string

The type of identifier used for the reason for contact (e.g., appointment ID, order ID, etc.)

string
required
length between 1 and 2147483647

The standard values are High, Routine, Low, but they can be customized out of these standard values

string
required
length between 1 and 2147483647

The message text that contains all the required information of this business

string
required
length between 1 and 2147483647

The message type of the message being sent, it ust correspond to the a value ourside of Epic's release range or part of the safelist. This element also accepts the title.

string
length between 1 and 2147483647

The patient identifier to include with the message, normally it is the FHIR type patient identifier

string
length between 1 and 2147483647

The patient ID type, possibilities are "CID", "RecordID", "Name", "NationalID", "MRN" etc...

recipients
array of objects
required

The recipients of the message, this is an array of object type Recipient

recipients*
string
required
length between 1 and 2147483647

The identifier corresponding to a user to be identified as the sender of the message. Type of identifier is given in sender_id_type

string
length between 1 and 2147483647

The sender id type, possibilities are "CID", "RecordID", "Name", "SystemLogin", "Alias" etc..., default is "Internal"

Responses
204

Successful operation

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json