POST api/v1/{EMRSystem}/Messages
Creates (sends) a new Message from a staff member to another staff member(s).
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmMessageCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| MessageTypeId |
Gets or sets the message type identifier. |
string |
Required if EMRSystem = Epic |
| Recipients |
Gets or sets the message recipients. |
Collection of MessageSendRecipient |
None. |
| Subject |
Gets or sets the message subject. |
string |
None. |
| MessageText |
Gets or sets the message text. |
string |
None. |
| MessageTextFormat |
Gets or sets the message text format. |
string |
None. |
| Priority |
Gets or sets the message priority. |
string |
None. |
| SendDate |
Gets or sets the message send date/time. |
datetime |
Date only |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Request Formats
application/json
{
"UserId": "sample string 1",
"MessageTypeId": "sample string 2",
"Recipients": [
{
"RecipientType": "sample string 1",
"RecipientId": "sample string 2",
"CC": true
},
{
"RecipientType": "sample string 1",
"RecipientId": "sample string 2",
"CC": true
}
],
"Subject": "sample string 3",
"MessageText": "sample string 4",
"MessageTextFormat": "sample string 5",
"Priority": "sample string 6",
"SendDate": "2025-12-12T21:07:08.5312+00:00",
"PatientId": "sample string 7",
"LoginId": "sample string 9",
"Password": "sample string 10",
"EmrInstance": "sample string 11",
"ApplicationName": "sample string 12",
"ApplicationKey": null,
"AuthorizationToken": "sample string 14",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmMessageCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageId |
The identifier of the created message. |
string |
None. |
Response Codes
Http Status Code 201 - Indicates that the requested record was successfully created.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
{
"MessageId": "sample string 1"
}