Developers
V1ClinicalAccess requestsRequestid

Practitioner checks their own request status; no health data

GET
/v1/clinical/access-requests/{requestId}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

requestId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/clinical/access-requests/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "pending",  "practitioner": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "licenseAuthority": "string",    "licenseNumber": "string",    "specialistRegistration": "string",    "specialty": "string",    "organization": "string",    "verifiedAt": "2019-08-24T14:15:22Z",    "verificationValidUntil": "2019-08-24T14:15:22Z"  },  "requestedAt": "2019-08-24T14:15:22Z",  "pendingExpiresAt": "2019-08-24T14:15:22Z",  "approvedAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "deniedAt": "2019-08-24T14:15:22Z",  "revokedAt": "2019-08-24T14:15:22Z",  "purpose": "consultation_recordkeeping",  "scope": "read_and_add",  "noticeVersion": "2026-09-09"}

Verified practitioner claims a QR to request access POST

Consumes the token once and creates a pending request. Neither reading nor writing is allowed until patient approval. Verification is provisioned manually by an administrator, never inferred from signup or OCR.

Read passport readings within your active patient-approved grant GET

Next Page