{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_pre-encounter.subpackage_pre-encounter/lists.subpackage_pre-encounter/lists/v1 API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_pre-encounter.subpackage_pre-encounter/lists.subpackage_pre-encounter/lists/v1", "type": "folder" }, "items": [ { "info": { "name": "Get Patient List", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/lists/v1/patient", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "page_token", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query", "description": "Defaults to patient.updatedAt." }, { "name": "sort_direction", "value": "", "type": "query", "description": "Defaults to ascending." }, { "name": "filters", "value": "", "type": "query" }, { "name": "include_deactivated", "value": "", "type": "query", "description": "If true, includes deactivated patients in the results. Defaults to false." }, { "name": "redirect_to_primary", "value": "", "type": "query", "description": "If true, and filtering by mrn equals, then only return the primary version of the patient requested" }, { "name": "hide_alternatives", "value": "", "type": "query", "description": "If true, then do not show alternative patients" } ] }, "docs": "Gets patients with dependent objects for patients that match the query parameters." }, { "info": { "name": "Get Appointment List", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/lists/v1/appointment", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "sort_field", "value": "", "type": "query", "description": "Defaults to appointment.startTimestamp." }, { "name": "sort_direction", "value": "", "type": "query", "description": "Defaults to asc." }, { "name": "limit", "value": "", "type": "query", "description": "Defaults to 100." }, { "name": "page_token", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" }, { "name": "include_deactivated", "value": "", "type": "query", "description": "If true, includes deactivated appointments in the results. Defaults to false." }, { "name": "include_merged_patient_data", "value": "", "type": "query", "description": "If true and a patient id is specified, then also include appointments from any alternative patients that are merged into this patient. Defaults to false." } ] }, "docs": "Searches for appointments that match the query parameters." } ] } ], "bundled": true }