Developers
V1MeClinicalRecords

Read your own clinical records, including correction history

GET
/v1/me/clinical/records

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default30
cursor?string
Match^[A-Za-z0-9_-]+$
Length1 <= length <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/me/clinical/records"
{  "records": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "code": "consultation",      "schemaVersion": "1.0.0",      "text": "string",      "encounterAt": "2019-08-24T14:15:22Z",      "recordedAt": "2019-08-24T14:15:22Z",      "source": "practitioner",      "authoredBy": {        "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"      },      "rootId": "5fbed245-3fa3-4aec-a906-36fce6169827",      "revision": 1,      "supersedesId": "688cf67a-2e6c-4e49-8750-5bc8809fcd6f"    }  ],  "nextCursor": "string"}

Issue your one-use five-minute clinical QR token POST

The token contains no health data and does not grant access. Encode only this opaque token in the QR. Send it in the claim POST body, never in a URL or analytics. A practitioner claim still requires your approval.

Export your own clinical records as portable JSON GET

Includes original and corrected records and author licence snapshots. Follow nextCursor until null. The response is private JSON; no public download URL is created.