Resolve refIds to Signals ids
Resolve refIds to Signals ids, through Ovok's Signals gateway.
Resolve refIds to Signals ids
| Method | Path |
|---|---|
GET | /v1/signals/api/patient/ids |
- Sandbox: available
- Staging: available
- Production: unknown
An object from each patientRefId this tenant holds to its Signals id. A refId the tenant does not hold is left out rather than failing the request.
Through ovok
- Who can call it: Manager apps, and users whose access policy grants the capabilities.
- Capabilities, all required:
signals_patients:read. Project admins have every capability; client applications get no admin bypass. - If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), name them with
patientRefId, each one you can read, at most 100. Signals then pages over just those patients, so pages and totals stay true. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes arefId; ovok asks Signals which patient a Signals id is.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
patientRefId | array of string | Yes | The caller's refIds to resolve. Repeat the parameter or separate with commas. |
Responses
| Status | Meaning |
|---|---|
200 | An object mapping each found refId to its Signals id: { [refId]: id }. |
400 | The query carries a raw #, or more than 200 parameters. |
401 | Your ovok access token, or your client id and secret, are missing or invalid. |
403 | ovok refused the call: you lack a capability this route needs, or your session has no project, or your access covers only some patients and the call names none. From Signals: Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
404 | A patient the call names is not one you can read. |
409 | Your project has no Signals tenant of its own (SIGNALS_TENANT_NOT_OWN), or it is moving to another one. |
422 | A patient id is not 1 to 64 letters, digits, ., _, ~ or -. More than 100 patients are named. From Signals: patientRefId was absent or too long a list. |
429 | Too many requests. Retry after the seconds in Retry-After. |
500 | ovok hit an unexpected fault, such as your project having no Signals submitter. |
502 | Signals answered with something ovok couldn't use, or refused ovok's own credential. |
503 | Signals is unavailable. Retry after the seconds in Retry-After. |
504 | Signals did not answer in time. |
Example
curl --request GET 'https://api.sandbox.ovok.com/v1/signals/api/patient/ids' \
--user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"Last updated on