API reference

Clinical records

Read-only access to a patient's medical record. Needs the records:read scope, which only doctors and clinic admins can grant. Handle this data with care: it's confidential health information.

Consultations (visits)

GET/api/v1/patients/{id}/consultationsScope: records:read

A patient's visits, newest first: complaints, diagnoses, medicines, tests, advice and follow-up date.

Field	Where	Type	Description
`id`required	in the path	uuid	The patient's ID.
`limit`	after ?	integer	Page size.
`cursor`	after ?	string	Next page.

Example request

bash

curl "https://your-healthfix-site/api/v1/patients/0b9f6f7e-3c1a-4f7e-9b1e-5f2d8a7c1e42/consultations?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

One consultation

GET/api/v1/consultations/{id}Scope: records:read

A single visit in full, including the prescription.

Field	Where	Type	Description
`id`required	in the path	uuid	The consultation's ID.

Example request

bash

curl "https://your-healthfix-site/api/v1/consultations/0b9f6f7e-3c1a-4f7e-9b1e-5f2d8a7c1e42" \
  -H "Authorization: Bearer YOUR_API_KEY"

Latest consultation

GET/api/v1/patients/{id}/consultations/latestScope: records:read

The most recent visit, handy for “what was prescribed last time?”.

Field	Where	Type	Description
`id`required	in the path	uuid	The patient's ID.

Example request

bash

curl "https://your-healthfix-site/api/v1/patients/0b9f6f7e-3c1a-4f7e-9b1e-5f2d8a7c1e42/consultations/latest" \
  -H "Authorization: Bearer YOUR_API_KEY"

Other record sections

GET/api/v1/patients/{id}/{section}Scope: records:read

Replace {section} with one of: vitals, case-history, lab-results, lab-orders, lab-trends, care-plans, documents, forms, notes.

Field	Where	Type	Description
`id`required	in the path	uuid	The patient's ID.
`section`required	in the path	string	vitals · case-history (conditions, allergies, medications, surgeries, family history) · lab-results · lab-orders · lab-trends · care-plans · documents (file list only) · forms · notes

Example request

bash

curl "https://your-healthfix-site/api/v1/patients/0b9f6f7e-3c1a-4f7e-9b1e-5f2d8a7c1e42/vitals" \
  -H "Authorization: Bearer YOUR_API_KEY"