{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1 API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1", "type": "folder" }, "items": [ { "info": { "name": "Search", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "mrn", "value": "", "type": "query" }, { "name": "similar_name_ordering", "value": "", "type": "query", "description": "A string that is used to order similar names in search results." } ] }, "docs": "Returns a list of Patients based on the search criteria." }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/patients/v1", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "skip_duplicate_check", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a patient. VersionConflictError is returned when the patient's external ID is already in use." }, { "info": { "name": "Create With Mrn", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/patients/v1/with_mrn", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "skip_duplicate_check", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient is created their MRN will not be editable. BadRequestError is returned when the MRN is greater than 20 characters. VersionConflictError is returned when the patient's external ID is already in use." }, { "info": { "name": "Get Multi", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1/get_multi", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "mrn", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" }, { "name": "sort_field", "value": "", "type": "query" }, { "name": "sort_direction", "value": "", "type": "query", "description": "Defaults to ascending." }, { "name": "redirect_to_primary", "value": "", "type": "query", "description": "If true, then only return the primary version of any patients requested" } ] }, "docs": "Searches for patients that match the query parameters." }, { "info": { "name": "Search Providers", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1/search_providers", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "search_criteria", "value": "", "type": "query" } ] }, "docs": "Searches for referring providers that match the query parameters. The search is case-insensitive, supports fuzzy matching, and matches against provider name and NPI. The search criteria must be an alphanumeric string, and the search is limited to the first 20 results." }, { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1/:id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Gets a patient." }, { "info": { "name": "Get By Mrn", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1/mrn/:mrn", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "mrn", "value": "", "type": "path" } ] }, "docs": "Gets a patient by mrn." }, { "info": { "name": "Get History", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1/:id/history", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Gets a patient along with it's full history. The return list is ordered by version ascending." }, { "info": { "name": "Get Coverage Snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1/:id/snapshot", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "date", "value": "", "type": "query" } ] }, "docs": "Gets a patient along with their coverages at a specific point in time. Note that the date passed in is only used to determine what the filing order was for that patient during that time. The actual data returned will always be the latest version of the patient and coverages." }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PUT", "url": "https://pre-api.joincandidhealth.com/patients/v1/:id/:version", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a patient. The path must contain the next version number to prevent race conditions. For example, if the current version of the patient is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the patient. Updating historic versions is not supported." }, { "info": { "name": "Reactivate", "type": "http" }, "http": { "method": "PATCH", "url": "https://pre-api.joincandidhealth.com/patients/v1/:id/:version", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ] }, "docs": "Removes the deactivated flag for a patient. The path must contain the most recent version plus 1 to prevent race conditions. Reactivating historic versions is not supported." }, { "info": { "name": "Deactivate", "type": "http" }, "http": { "method": "DELETE", "url": "https://pre-api.joincandidhealth.com/patients/v1/:id/:version", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ] }, "docs": "Sets a patient as deactivated. The path must contain the most recent version plus 1 to prevent race conditions. Deactivating historic versions is not supported." }, { "info": { "name": "Scan", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/patients/v1/updates/scan", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "since", "value": "", "type": "query" }, { "name": "maxResults", "value": "", "type": "query" } ] }, "docs": "Scans up to 1000 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.\n\n**Polling Pattern:**\nTo continuously poll for updates without gaps:\n1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`)\n2. The API returns 100 by default and up to 1000 patient records, sorted by `updated_at` ascending\n3. Find the `updated_at` value from the last record in the response\n4. Use that `updated_at` value as the `s" } ] } ], "bundled": true }