Get all patients with extended (research) details
Most data about an individual patient is available through specific calls for patient documents, demographics, vitals, etc. However, for research purposes you often want to pull a large amount of discrete data about patients, so Cerbo provides a specific endpoint that aggregates most relevant data into a single call.
To access your patient's extended data, first run an API call to return all patients, then loop through the patient ids returned in that response and fetch each patient's extended details.
Please note: All dates listed are listed in UTC, so you'll want to adjust for your local timezone. Also, the API responses include some routes that may not be available for your instance.
Also note: The responses for this call can often be large (more than 1MB/patient in some scenarios) so response times to this call can vary. Please rate-limit this call to 20 calls/second and we recommend waiting until after business hours if you are going to run this for all patients.
For a full sample response, please visit https://demo1.md-hq.com/custom/sample_data/extended_details.json
Request
- Base URL: https://clinic-subdomain.md-hq.com/api/v1
- URL: https://clinic-subdomain.md-hq.com/api/v1/patients/{id}/extended_details
- Auth: HTTP basic
Path parameters
The ID of the patient.
Query parameters
The return values will strip PHI identifiers from the chart including: names, street-level addresses, telephone numbers (area codes will remain), date-of-birth (year of birth will remain) and some questionnaire answers. Because ever client has different questionnaires, you will want to make sure you further anonymize the results if your questionnaires include requests for identifying information
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.