v1

latestOpenAPI 3.0.02026-07-14307078.8 KB

patient notification

Acknowledgment response for SMS notification sent to patient by HIP

If the SMS notification is successfully sent to patient then "status" will be "ACKNOWLEDGED" with no error. If the SMS notification is failed then "status" will be "ERRORED" with error.

post/v0.5/patients/sms/on-notify

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server, which will be sent by gateway to authenticate itself with API bridge.

X-HIP-IDstring required

Identifier of the health information provider to which the request was intended.

Request body

requestIdstring uuid required

a nonce, unique for each HTTP request

status'ACKNOWLEDGED' | 'ERRORED'

timestampstring date-time required

Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

Example request

{
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request Accepted