{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1", "type": "folder" }, "items": [ { "info": { "name": "Get Charge Capture Claim Creation", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/charge_capture_claim_creation/v1/:charge_capture_claim_creation_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "charge_capture_claim_creation_id", "value": "", "type": "path" } ] }, "docs": "Get Charge Capture Claim Creation" }, { "info": { "name": "Get Charge Capture Claim Creation Summary", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/charge_capture_claim_creation/v1/all/summary", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Get Charge Capture Claim Creation Summary" }, { "info": { "name": "Mark a ClaimCreationAttempt error as resolved", "type": "http" }, "http": { "method": "PATCH", "url": "https://pre-api.joincandidhealth.com/api/charge_capture_claim_creation/v1/error/:charge_capture_bundle_error_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "charge_capture_bundle_error_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mark a ClaimCreationAttempt error as resolved" }, { "info": { "name": "Get all Charge Capture Claim Creations", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/charge_capture_claim_creation/v1", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of entities per page, defaults to 100." }, { "name": "sort", "value": "", "type": "query", "description": "Defaults to created_at" }, { "name": "sort_direction", "value": "", "type": "query", "description": "Sort direction. Defaults to descending order if not provided." }, { "name": "page_token", "value": "", "type": "query" }, { "name": "patient_external_id", "value": "", "type": "query", "description": "The patient ID from the external EMR platform for the patient" }, { "name": "claim_creation_status", "value": "", "type": "query", "description": "the status of the charge capture Claim Creation, refers to whether it was able to create a claim." }, { "name": "charge_status", "value": "", "type": "query", "description": "the status of the charge captures" }, { "name": "charge_external_id", "value": "", "type": "query", "description": "A client-specified unique ID to associate with this encounter;\nfor example, your internal encounter ID or a Dr. Chrono encounter ID.\nThis field should not contain PHI." }, { "name": "date_of_service_min", "value": "", "type": "query", "description": "Date formatted as YYYY-MM-DD; eg: 2019-08-24.\nThis date must be the local date in the timezone where the service occurred." }, { "name": "date_of_service_max", "value": "", "type": "query", "description": "Date formatted as YYYY-MM-DD; eg: 2019-08-24.\nThis date must be the local date in the timezone where the service occurred." }, { "name": "claim_ids", "value": "", "type": "query", "description": "A list of claim IDs to filter by. This will return all charge capture claim_creations that have a resulting claim with one of the IDs in this list." }, { "name": "claim_creation_ids", "value": "", "type": "query", "description": "A list of Claim Creation IDs to filter by." }, { "name": "billing_provider_npis", "value": "", "type": "query", "description": "A list of billing provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list." }, { "name": "service_facility_name", "value": "", "type": "query", "description": "A string to filter by. This will return all charge capture claim_creations which include one or more charges with this service facility name." }, { "name": "primary_payer_ids", "value": "", "type": "query", "description": "A list of primary payer IDs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the primary payer IDs in this list." }, { "name": "rendering_provider_npis", "value": "", "type": "query", "description": "A list of rendering provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list." }, { "name": "rendering_provider_names", "value": "", "type": "query", "description": "A list of rendering provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list." }, { "name": "supervising_provider_npis", "value": "", "type": "query", "description": "A list of supervising provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list." }, { "name": "supervising_provider_names", "value": "", "type": "query", "description": "A list of supervising provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list." }, { "name": "claim_status", "value": "", "type": "query", "description": "the status of the claim to filter by created from charge capture bundle." }, { "name": "claim_creation_category", "value": "", "type": "query", "description": "A list of claim creation categories to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list." }, { "name": "tags", "value": "", "type": "query", "description": "A list of tags to filter by. This will return all charge captures with one of the tags." }, { "name": "primary_payer_names", "value": "", "type": "query", "description": "A list of primary payer names to filter by. This will return all charge captures with one of the names." }, { "name": "patient_names", "value": "", "type": "query", "description": "A list of patient names to filter by. This will return all charge captures with one of the names." }, { "name": "has_charge_capture_updates", "value": "", "type": "query", "description": "If true, only return claim_creations that have charge captures that have been updated since the Claim Creation has had a status of BILLED. See the updates property on ChargeCapture for more details." } ] }, "docs": "Get all Charge Capture Claim Creations" } ] } ], "bundled": true }