Skip to content

Acknowledge a request from the EMR

Marks an open request as seen when a clinician handles it in the EMR. The patient sees the same result as a console acknowledgement: "Seen by {name}" for a linked practitioner, otherwise the generic care-team copy. Already acknowledged answers 200 with the current state; resolved or cancelled answers `409 conflict`. Requires the site's request write-back switch.

POST
/v1/requests/{requestId}/acknowledge

Marks an open request as seen when a clinician handles it in the EMR. The patient sees the same result as a console acknowledgement: "Seen by {name}" for a linked practitioner, otherwise the generic care-team copy. Already acknowledged answers 200 with the current state; resolved or cancelled answers 409 conflict. Requires the site's request write-back switch.

Authorization

AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: requests:write

Path Parameters

requestId*string

An opaque req_ id.

Match^req_[0-9A-Za-z]{16,64}$

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Idempotency-Key?string

1–255 characters of [A-Za-z0-9._:-] (a UUID v4 is recommended); never PHI. Stored 24 hours per app.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/requests/req_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e/acknowledge" \  -H "Content-Type: application/json" \  -d '{    "by": {      "practitioner": {        "display": "Sam Rivera",        "externalId": "SYN-N4455",        "idSystem": "epic-ser"      }    }  }'
{  "acknowledgedAt": "2026-09-14T15:00:11.402Z",  "acknowledgedBy": {    "appId": "app_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",    "kind": "staff",    "practitioner": {      "display": "string",      "identifiers": [        {          "externalId": "string",          "idSystem": "string"        }      ]    }  },  "category": "location",  "createdAt": "2026-09-14T15:00:11.402Z",  "encounterId": "enc_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "escalationLevel": 0,  "id": "req_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "label": {    "en": "string",    "fr": "string"  },  "object": "request",  "outcome": "done",  "priority": "low",  "resolvedAt": "2026-09-14T15:00:11.402Z",  "routedTo": {    "kind": "string"  },  "site": "kb-main-ed",  "status": "open",  "type": "string",  "updatedAt": "2026-09-14T15:00:11.402Z",  "version": -9007199254740991}

Was this page helpful?