{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_encounter-attachments.subpackage_encounter-attachments/v1 API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_encounter-attachments.subpackage_encounter-attachments/v1", "type": "folder" }, "items": [ { "info": { "name": "Get Encounter Attachments", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/encounter-attachments/v1/:encounter_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "encounter_id", "value": "", "type": "path" } ] }, "docs": "Get Encounter Attachments" }, { "info": { "name": "Create Encounter Attachment", "type": "http" }, "http": { "method": "PUT", "url": "https://pre-api.joincandidhealth.com/api/encounter-attachments/v1/:encounter_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "encounter_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment_file", "type": "text", "value": "" }, { "name": "attachment_type", "type": "text", "value": "" } ] } }, "docs": "Uploads a file to the encounter. The file will be stored in the\nencounter's attachments. Deprecated: Use create-v2 instead." }, { "info": { "name": "Delete Encounter Attachment", "type": "http" }, "http": { "method": "DELETE", "url": "https://pre-api.joincandidhealth.com/api/encounter-attachments/v1/:encounter_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "encounter_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Encounter Attachment" }, { "info": { "name": "Create Encounter Attachment V2", "type": "http" }, "http": { "method": "PUT", "url": "https://pre-api.joincandidhealth.com/api/encounter-attachments/v1/:encounter_id/v2", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "encounter_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment_file", "type": "text", "value": "" }, { "name": "attachment_type", "type": "text", "value": "" }, { "name": "description", "type": "text", "value": "" } ] } }, "docs": "Uploads a file to the encounter. The file will be stored in the\nencounter's attachments." }, { "info": { "name": "Create an Attachment from a Charge Capture external ID", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/api/encounter-attachments/v1/create-from-charge-capture-external-id", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "charge_capture_external_id", "type": "text", "value": "" }, { "name": "attachment_file", "type": "text", "value": "" }, { "name": "attachment_type", "type": "text", "value": "" }, { "name": "description", "type": "text", "value": "" } ] } }, "docs": "Uploads a file using an external identifier. For Charge Capture, the file will be associated with the Encounter at Encounter creation time.\n\nNote: Attachments created via this endpoint are not searchable via the get endpoint until they are associated with an encounter." }, { "info": { "name": "Get Attachments by Charge Capture External ID", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/encounter-attachments/v1/by-charge-capture-external-id/:charge_capture_external_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "charge_capture_external_id", "value": "", "type": "path" } ] }, "docs": "Returns all attachments associated with the given charge capture external ID." }, { "info": { "name": "Delete Attachment by Charge Capture External ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://pre-api.joincandidhealth.com/api/encounter-attachments/v1/by-charge-capture-external-id/:charge_capture_external_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "charge_capture_external_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an attachment associated with the given charge capture external ID." } ] } ], "bundled": true }