Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful list health documents.

id
string<uuid>
required
read-only

Unique identifier of this resource. Returned by the server; not writable.

url
string<uri>
required
read-only

URL returned for this resource; provider links may expire. Returned by the server; not writable.

filename
string
required
read-only

Filename for this patient document. Returned by the server; not writable.

content_type
string
required

Content type for this patient document. Maximum 100 characters.

Maximum string length: 100
size_bytes
integer
required

Size bytes for this patient document.

consultation
string<uuid> | null
required
read-only

Consultation for this patient document. Returned by the server; not writable. May be null when unavailable.

consultation_summary
required

Consultation summary for this patient document. Returned by the server; not writable. May be null when unavailable.

uploaded_at
string<date-time>
required
read-only

Uploaded at timestamp in ISO 8601 format. Returned by the server; not writable.

kind
enum<string>

Document or PDF variant selected by the endpoint.

Available options:
prescription,
lab_result,
photo,
other
note
string

Optional note attached to the resource. Maximum 500 characters.

Maximum string length: 500