Services API: Notification Ack Service
The purpose of this service (Step n6) is to notify that a message has been processed.
Resource:
POST /partners/services/api/v1/notification/ack
Authentication:
Endpoint is secured with mutual TLS. More information can be found here: API Authentication
Request Headers:
| Name | Type | Description | Example |
|---|---|---|---|
| org_id | String | Organization OID | 3.16.724.4.41 |
| x-origin-request-id | String | Request Unique ID generated by EMR middleware (UUID) | 5109d51b-421e-4746-b673-16e3fe2b3442 |
| x-operation-id | String | A unique ID to track end-to-end flow of messages between Roche DI and EMR Middleware. This unique ID which was sent in the Notification message by Roche DI should be returned back to Roche DI in header value of Notification ACK Service via the header parameter x-operation-id | ea34d51b-421e-3216-b673-16e3fe2b3442 |
| client_id | String | Public identifier for organizations generated by Roche DC | e63ab70a4fea4034bcf50b5ecfdb2994 |
| client_secret | String | Client related secret known only to the EMR and Roche DC | CaC74B40140D4a0280478E4188682241 |
| Content-Type | String | application/json | application/json |
| receiptHandle | String | Receipt Handle from the Notification message | AQEB / HM0FfuUJEm3ZW + ss9T9IUo6ONzL / 7261n ZZqmBBpNxemmJwtUCe4IisQdyK2ZaHjhcKFJpLJbh4ge7oWYWA6AOcYlt / +EZSvLH + 6 z9XvQtBQt / jL72jku4NUgixs2uk + 9 UeA1EG + zZs9RFYUHstPIv17yFyI038BbZaKJpZGV + auiWuwd7zrfudWF3cJuCZsiSruFALVtt + RME + VPjF1JOmrfGPZCY3eK2MioAOwjt9yacLezqhTLKl6aaVpzUg1T05hu9NJbnM43 + 4 WdlCm5X7FuAud4knS6BKkFiLvvSEbgxXATjDAPsCn9Ze + Q9vUXM9V86WQxhwzTte3slDJqfo6QiJLUwh4ngfjNMr3q6 + dc9idSnFH4oZ08ZW9wuN7O5LT8vYhfF3Tppw / YP0aH5RoAs7momCCo7uIm + dEO8 = |
Example cURL Request:
curl -L -X POST 'https://api-services-demo.rochedcplatform-sandbox.com/partners/services/api/v1/notification/ack' -H 'client_id: {CLIENT_ID}' -H 'client_secret: {CLIENT_SECRET}' -H 'org_id: {ORG_ID}' -H 'x-operation-id: ea34d51b-421e-3216-b673-16e3fe2b3442' -H 'Content-Type: application/json' -H 'receiptHandle: {RECEIPT_HANDLE}' -H 'Accept: application/json' --data-raw '
Mappings:
| NotificationMessage | cURL Request |
|---|---|
| EmrOid | org_id |
| x-operation-id (Header) | x-operation-id |
| MessageReceiptHandle | receiptHandle |
Success Reponse:
HTTP Status Code 200 Message was notified successfully.