{ "opencollection": "1.0.0", "info": { "name": "FastAPI", "version": "0.1.0" }, "items": [ { "info": { "name": "health", "type": "folder" }, "items": [ { "info": { "name": "Health Check", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/health/" }, "docs": "Basic health check to determine if the API is up\nReturns:\n 200" } ] }, { "info": { "name": "providers", "type": "folder" }, "items": [ { "info": { "name": "Set Clinical Status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/providers/:provider_id/clinical_status/", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set Clinical Status" }, { "info": { "name": "Promote Provider To Clinical", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/providers/:provider_id/promote/", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Promote Provider To Clinical" }, { "info": { "name": "Get All Providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/providers/", "params": [ { "name": "include_roles", "value": "", "type": "query" }, { "name": "fail_on_roles_error", "value": "", "type": "query" }, { "name": "clinical_status", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get All Providers" }, { "info": { "name": "Create Provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/providers/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Provider" }, { "info": { "name": "Fetch Co Assigned Providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/providers/co_assigned/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "clinical_relationship", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Co Assigned Providers" }, { "info": { "name": "Get Provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/providers/:provider_id/", "params": [ { "name": "provider_id", "value": "", "type": "path" }, { "name": "include_roles", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Provider" }, { "info": { "name": "Patch Provider", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/providers/:provider_id/", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Provider" }, { "info": { "name": "Update Provider Email", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/providers/:provider_id/email/", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Provider Email" }, { "info": { "name": "Get Provider Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/providers/info", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Provider Info" }, { "info": { "name": "Send Password Reset Email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/providers/:provider_id/password_reset/", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send Password Reset Email" }, { "info": { "name": "Set Provider Qa Billing Status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/providers/:provider_id/qa_billing_status/", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set Provider Qa Billing Status" }, { "info": { "name": "Get Provider State License", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/providers/:provider_id/provider_licenses/:state/", "params": [ { "name": "provider_id", "value": "", "type": "path" }, { "name": "state", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Provider State License" }, { "info": { "name": "Get Provider Payor Credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/providers/:provider_id/provider_payor_credentials/:payor_id/", "params": [ { "name": "provider_id", "value": "", "type": "path" }, { "name": "payor_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Provider Payor Credentials" }, { "info": { "name": "Fetch Guardian Relationship Manager Assignments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/providers/:guardian_provider_id/relationship_manager/", "params": [ { "name": "guardian_provider_id", "value": "", "type": "path" }, { "name": "exclude_inactive", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Guardian Relationship Manager Assignments" } ] }, { "info": { "name": "provider_assignments", "type": "folder" }, "items": [ { "info": { "name": "Fetch Provider Assignments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/provider_assignments/", "params": [ { "name": "active_only", "value": "", "type": "query" }, { "name": "clinical_relationship", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "provider_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Provider Assignments" }, { "info": { "name": "Create Provider Assignment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/provider_assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Provider Assignment" }, { "info": { "name": "Patch Provider Assignment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/provider_assignments/:provider_assignment_id/", "params": [ { "name": "provider_assignment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Provider Assignment" }, { "info": { "name": "Delete Provider Assignment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/provider_assignments/:provider_assignment_id/", "params": [ { "name": "provider_assignment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Provider Assignment" } ] }, { "info": { "name": "sessions", "type": "folder" }, "items": [ { "info": { "name": "Get Sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "include_qa_stats", "value": "", "type": "query" }, { "name": "bay", "value": "", "type": "query" }, { "name": "include_participated_only", "value": "", "type": "query" }, { "name": "find_by_provider_id_only", "value": "", "type": "query" }, { "name": "action_required", "value": "", "type": "query" }, { "name": "client_clinical_status", "value": "", "type": "query" }, { "name": "pending_parent_signature", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Sessions" }, { "info": { "name": "Create Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Session" }, { "info": { "name": "Get Sessions Awaiting Guardian Signature", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/awaiting_guardian_signature/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Sessions Awaiting Guardian Signature" }, { "info": { "name": "Bay7 Guardian Signature", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/bay7/guardian_signature/", "headers": [ { "name": "x-forwarded-for", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Bay7 Guardian Signature" }, { "info": { "name": "Get Unacknowledged Sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/awaiting_acknowledgement/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns sessions of which most recent QA review is not acknowledged yet\nRoles Allowed: pRBT, BCBA, Admin\nArgs:\n provider:\nReturns:\n list[SessionResponse]" }, { "info": { "name": "Get Sessions With Claim History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/claim_history/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "include_qa_stats", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" }, { "name": "bay", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Roles Allowed: Clinical QA, Biller, Admin\nArgs:\n client_id:\n start:\n end:\n include_qa_stats:\n provider:\n session_model_converter:\n session_repo:\n session_service:\n clinical_qa_review_repo:\n\nReturns:\n list[SessionResponseWithClaimStatus]" }, { "info": { "name": "Get Session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/:session_id/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Session" }, { "info": { "name": "Patch Session", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Session" }, { "info": { "name": "Delete Session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/sessions/:session_id/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Session" }, { "info": { "name": "Stop Session", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/stop/", "headers": [ { "name": "x-forwarded-for", "value": "" } ], "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop Session" }, { "info": { "name": "Reset Session Status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/reset_status/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset Session Status" }, { "info": { "name": "Queue To Regenerate Clinical Qa Review Pdf", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/:clinical_qa_review_id/pdf_regenerate/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "clinical_qa_review_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Allows only Admin\nChecks:\n1. Check if clinical qa review exists\n2. Check if clinical qa review status is allowed to generate pdf report" }, { "info": { "name": "Get Session Practiced Targets Trials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Session Practiced Targets Trials" }, { "info": { "name": "Create Trial", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Trial" }, { "info": { "name": "Patch Trial", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Trial" }, { "info": { "name": "Delete Trial", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Trial" }, { "info": { "name": "Create Trial Duration Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/duration_events/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Trial Duration Event" }, { "info": { "name": "Update Trial Duration Event", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/duration_events/:duration_event_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "duration_event_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Trial Duration Event" }, { "info": { "name": "Delete Trial Duration Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/duration_events/:duration_event_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "duration_event_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Trial Duration Event" }, { "info": { "name": "Create Trial Rate Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/rate_events/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Trial Rate Event" }, { "info": { "name": "Update Trial Rate Event", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/rate_events/:rate_event_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "rate_event_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Trial Rate Event" }, { "info": { "name": "Delete Trial Rate Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/sessions/:session_id/trials/:trial_id/rate_events/:rate_event_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "rate_event_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Trial Rate Event" }, { "info": { "name": "Download Session Pdf", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/:session_id/download/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download Session Pdf" }, { "info": { "name": "Get Clinical Qa Review Pdf", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/:clinical_qa_review_id/download/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "clinical_qa_review_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch most recent PDF document for a clinical qa review\nPDF is returned as a pre-signed URL" }, { "info": { "name": "Create Clinical Qa Review", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Clinical Qa Review" }, { "info": { "name": "Save Clinical Qa Review", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/:clinical_qa_review_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "clinical_qa_review_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Save Clinical Qa Review" }, { "info": { "name": "Delete Clinical Qa Review", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/:clinical_qa_review_id/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "clinical_qa_review_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Clinical Qa Review" }, { "info": { "name": "Submit Clinical Qa Review", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/:clinical_qa_review_id/stop/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "clinical_qa_review_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Submit Clinical Qa Review" }, { "info": { "name": "Acknowledge Clinical Qa Review", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/:clinical_qa_review_id/acknowledge/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "clinical_qa_review_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Acknowledge Clinical Qa Review" }, { "info": { "name": "Create Clinical Qa Review Submission Discourse", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/clinical_qa_reviews/:clinical_qa_review_id/discourses/", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "clinical_qa_review_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Clinical Qa Review Submission Discourse" }, { "info": { "name": "Fetch Review Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/data/review_summary/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Review Summary" }, { "info": { "name": "Fetch Trial Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/data/trial_summary/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "goal_id", "value": "", "type": "query" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Trial Summary" }, { "info": { "name": "Get Utilization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/data/utilization/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "utc_offset", "value": "", "type": "query" }, { "name": "client_ids", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Query params:\n start: start date (local time)\n end: end date (local time)\n utc_offset: utc offset\n client_ids: if client_id is not specified, return empty list" }, { "info": { "name": "Construct Session Narrative Suggestion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/narrative_suggestion/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Construct Session Narrative Suggestion" }, { "info": { "name": "Patch Session Symptoms Interventions", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/symptoms-interventions/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Session Symptoms Interventions" }, { "info": { "name": "Patch Session Progress Synopsis", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/progress-synopsis/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Session Progress Synopsis" }, { "info": { "name": "Patch Session Narrative", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/narrative/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Session Narrative" }, { "info": { "name": "Guardian Sign Session", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/guardian_sign/", "headers": [ { "name": "x-forwarded-for", "value": "" } ], "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Guardian Sign Session" }, { "info": { "name": "Terminate Session", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/sessions/:session_id/terminate/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Terminate Session" }, { "info": { "name": "Make Session Unbillable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/make_unbillable/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Session Unbillable" }, { "info": { "name": "Make Session Billable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/make_billable/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Session Billable" }, { "info": { "name": "Edit Session", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/edit/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Edit Session" }, { "info": { "name": "Backdate Session", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/sessions/:session_id/backdate/", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Backdate Session" }, { "info": { "name": "Start Evv Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/evv/start", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "replace_active", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start Evv Token" }, { "info": { "name": "End Evv Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/sessions/:session_id/evv/end", "params": [ { "name": "session_id", "value": "", "type": "path" }, { "name": "replace_active", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "End Evv Token" }, { "info": { "name": "Get Session Evv Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/sessions/:session_id/evv/status", "params": [ { "name": "session_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Session Evv Status" } ] }, { "info": { "name": "evv", "type": "folder" }, "items": [ { "info": { "name": "Capture Evv Gps", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/evv/capture_gps", "headers": [ { "name": "X-EVV-Token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Capture Evv Gps" } ] }, { "info": { "name": "clients", "type": "folder" }, "items": [ { "info": { "name": "Set Clinical Status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/clients/:client_id/clinical_status/", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set Clinical Status" }, { "info": { "name": "Get All Clients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/clients/", "params": [ { "name": "clinical_status", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get All Clients" }, { "info": { "name": "Create Client", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/clients/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Client" }, { "info": { "name": "Get Client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/clients/:client_id/", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Client" }, { "info": { "name": "Patch Client", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/clients/:client_id/", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Client" }, { "info": { "name": "Fetch Client Families", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/clients/families/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "date_active", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Client Families" }, { "info": { "name": "Reset Client Assessment Allocation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/clients/:client_id/reset_assessment_allocation/", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset Client Assessment Allocation" }, { "info": { "name": "Get Client Modifier Matrix Rows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/clients/:client_id/modifier_matrix/", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Client Modifier Matrix Rows" }, { "info": { "name": "Create Client Modifier Matrix Row", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/clients/:client_id/modifier_matrix/", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Client Modifier Matrix Row" }, { "info": { "name": "Replace Client Modifier Matrix Row", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/clients/:client_id/modifier_matrix/:modifier_matrix_id/", "params": [ { "name": "client_id", "value": "", "type": "path" }, { "name": "modifier_matrix_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace Client Modifier Matrix Row" }, { "info": { "name": "Delete Client Modifier Matrix Row", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/clients/:client_id/modifier_matrix/:modifier_matrix_id/", "params": [ { "name": "client_id", "value": "", "type": "path" }, { "name": "modifier_matrix_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Client Modifier Matrix Row" } ] }, { "info": { "name": "policies", "type": "folder" }, "items": [ { "info": { "name": "Get Policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/policies/", "params": [ { "name": "client_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Policies" }, { "info": { "name": "Create Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/policies/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Policy" }, { "info": { "name": "Get Policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/policies/:policy_id/", "params": [ { "name": "policy_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Policy" }, { "info": { "name": "Patch Policy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/policies/:policy_id/", "params": [ { "name": "policy_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Policy" }, { "info": { "name": "Get Prior Authorization Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/policies/:policy_id/prior_authorization_details/:service_code_id/", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "service_code_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Prior Authorization Details" } ] }, { "info": { "name": "client_facility_assignments", "type": "folder" }, "items": [ { "info": { "name": "Fetch Client Facility Assignments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_facility_assignments/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "active_only", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Client Facility Assignments" }, { "info": { "name": "Create Client Facility Assignments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/client_facility_assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Client Facility Assignments" }, { "info": { "name": "Update Client Facility Assignment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/client_facility_assignments/:client_facility_assignment_id/", "params": [ { "name": "client_facility_assignment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Client Facility Assignment" }, { "info": { "name": "Delete Client Facility Assignment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/client_facility_assignments/:client_facility_assignment_id/", "params": [ { "name": "client_facility_assignment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Client Facility Assignment" } ] }, { "info": { "name": "service_codes", "type": "folder" }, "items": [ { "info": { "name": "Get Service Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/service_codes/", "params": [ { "name": "is_timesheet_usable", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Service Codes" }, { "info": { "name": "Create Service Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/service_codes/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Service Code" } ] }, { "info": { "name": "client_supervisions", "type": "folder" }, "items": [ { "info": { "name": "Fetch Client Supervisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_supervisions/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "status_id", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "action_required", "value": "", "type": "query" }, { "name": "client_clinical_status", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Client Supervisions" }, { "info": { "name": "Create Client Supervision Notes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/client_supervisions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Client Supervision Notes" }, { "info": { "name": "Get Client Supervision Notes With Claim Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_supervisions/claim_history/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Client Supervision Notes With Claim Status" }, { "info": { "name": "Get Client Supervision Note", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Client Supervision Note" }, { "info": { "name": "Patch Client Supervision Notes", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Client Supervision Notes" }, { "info": { "name": "Delete Client Supervision", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Client Supervision" }, { "info": { "name": "Create Client Supervision Notes Target Phase", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/target_phase/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Client Supervision Notes Target Phase" }, { "info": { "name": "Delete Client Supervision Note Target Phase", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/target_phase/:target_phase_id/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" }, { "name": "target_phase_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Client Supervision Note Target Phase" }, { "info": { "name": "Stop Client Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/stop/", "headers": [ { "name": "x-forwarded-for", "value": "" } ], "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop Client Supervision" }, { "info": { "name": "Get Utilization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_supervisions/data/utilization/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Utilization" }, { "info": { "name": "Download Client Supervision Pdf", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/download/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download Client Supervision Pdf" }, { "info": { "name": "Make Client Supervision Unbillable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/make_unbillable/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Client Supervision Unbillable" }, { "info": { "name": "Make Client Supervision Billable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/make_billable/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Client Supervision Billable" }, { "info": { "name": "Edit Client Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/edit/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Edit Client Supervision" }, { "info": { "name": "Backdate Client Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_supervisions/:client_supervision_id/backdate/", "params": [ { "name": "client_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Backdate Client Supervision" } ] }, { "info": { "name": "timesheets", "type": "folder" }, "items": [ { "info": { "name": "Get Pay Period", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/timesheets/pay_periods/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Pay Period" }, { "info": { "name": "Get Timesheets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/timesheets/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "service_code_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Timesheets" }, { "info": { "name": "Create Timesheet", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/timesheets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Timesheet" }, { "info": { "name": "Patch Timesheet", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/timesheets/:timesheet_id/", "params": [ { "name": "timesheet_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Timesheet" }, { "info": { "name": "Delete Timesheet", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/timesheets/:timesheet_id/", "params": [ { "name": "timesheet_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Timesheet" } ] }, { "info": { "name": "treatment_plan", "type": "folder" }, "items": [ { "info": { "name": "Read Treatment Plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "action_required", "value": "", "type": "query" }, { "name": "client_clinical_status", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" }, { "name": "with_activation_logs", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get list of treatment plans by client ID with optional activation logs.\n\nArgs:\n client_id: Optional client ID to filter treatment plans\n action_required: Filter for treatment plans requiring action\n client_clinical_status: Filter by client clinical status\n status: Filter by treatment plan status\n expand: Optional sub-resources to include in response\n with_activation_logs: Include full activation log history for each treatment plan\n\nReturns:\n List of treatment plans with opti" }, { "info": { "name": "Create Treatment Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Treatment Plan" }, { "info": { "name": "Get Prior Authorizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/prior_authorizations/", "params": [ { "name": "pa_expires_within_days", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Prior Authorizations" }, { "info": { "name": "Read Treatment Plan By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read Treatment Plan By Id" }, { "info": { "name": "Patch Treatment Plan", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Treatment Plan" }, { "info": { "name": "Delete Treatment Plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Treatment Plan" }, { "info": { "name": "Stop Treatment Plan", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/stop/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop Treatment Plan" }, { "info": { "name": "Queue To Regenerate Treatment Plan Pdf", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/pdf_regenerate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Queue To Regenerate Treatment Plan Pdf" }, { "info": { "name": "Read All Goals", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "date", "value": "", "type": "query" }, { "name": "include_pending", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read All Goals" }, { "info": { "name": "Create Goal", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Goal" }, { "info": { "name": "Read All Medications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medications/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read All Medications" }, { "info": { "name": "Create Medication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medications/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Medication" }, { "info": { "name": "Patch Goal", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Goal" }, { "info": { "name": "Delete Goal", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Goal" }, { "info": { "name": "Read Medication", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medications/:medication_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "medication_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read Medication" }, { "info": { "name": "Patch Medication", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medications/:medication_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "medication_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Medication" }, { "info": { "name": "Delete Medication", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medications/:medication_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "medication_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Medication" }, { "info": { "name": "Create Target", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Target" }, { "info": { "name": "Patch Target", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/:target_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Target" }, { "info": { "name": "Delete Target", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/:target_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Target" }, { "info": { "name": "Change Target Stage", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/:target_id/change_stage/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Change Target Stage" }, { "info": { "name": "Update Last Target Stage Change", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/:target_id/change_stage/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Last Target Stage Change" }, { "info": { "name": "Delete Last Target Stage Change", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/:target_id/change_stage/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Last Target Stage Change" }, { "info": { "name": "Change Target Stage In Bulk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/bulk_change_stage/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Change Target Stage In Bulk" }, { "info": { "name": "Read Assessment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read Assessment" }, { "info": { "name": "Create Assessment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Assessment" }, { "info": { "name": "Patch Assessment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Assessment" }, { "info": { "name": "Delete Assessment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Assessment" }, { "info": { "name": "Get All Tools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get All Tools" }, { "info": { "name": "Create Assessment Tool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Assessment Tool" }, { "info": { "name": "Patch Assessment Tool", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/:tool_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Assessment Tool" }, { "info": { "name": "Delete Tool", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/:tool_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Tool" }, { "info": { "name": "Get Assessment Tool Documents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/:tool_id/documents/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Assessment Tool Documents" }, { "info": { "name": "Create Assessment Tool Document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/:tool_id/documents/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Assessment Tool Document" }, { "info": { "name": "Patch Assessment Tool Document", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/:tool_id/documents/:document_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" }, { "name": "document_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Assessment Tool Document" }, { "info": { "name": "Delete Assessment Tool Document", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/:tool_id/documents/:document_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" }, { "name": "document_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Assessment Tool Document" }, { "info": { "name": "Reupload Assessment Tool Document Visual", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/tools/:tool_id/documents/:document_id/reupload_visual/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" }, { "name": "document_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reupload Assessment Tool Document Visual" }, { "info": { "name": "Get Crisis Plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/crisis_plans/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Crisis Plans" }, { "info": { "name": "Create Crisis Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/crisis_plans/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Crisis Plan" }, { "info": { "name": "Patch Crisis Plan", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/crisis_plans/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Crisis Plan" }, { "info": { "name": "Delete Crisis Plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/crisis_plans/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Crisis Plan" }, { "info": { "name": "Get Discharge And Transition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read discharge from treatment plan" }, { "info": { "name": "Create Discharge And Transition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Discharge And Transition" }, { "info": { "name": "Patch Discharge And Transition", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/:discharge_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "discharge_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing discharge and transition plan" }, { "info": { "name": "Delete Discharge And Transition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/:discharge_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "discharge_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete discharge and transition" }, { "info": { "name": "Get Discharge And Transition Reason", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/:discharge_id/reasons/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "discharge_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get reasons for discharge" }, { "info": { "name": "Create Discharge And Transition Reasons", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/:discharge_id/reasons/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "discharge_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create discharge and transition plan reasons" }, { "info": { "name": "Patch Discharge And Transition Reason", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/:discharge_id/reasons/:reason_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "discharge_id", "value": "", "type": "path" }, { "name": "reason_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing reasons for discharge and transition plan" }, { "info": { "name": "Delete Discharge And Transition Reason", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/discharges/:discharge_id/reasons/:reason_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "discharge_id", "value": "", "type": "path" }, { "name": "reason_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete discharge and transition plan reason" }, { "info": { "name": "Get Education Background", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/education_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "read education background by treatment plan id" }, { "info": { "name": "Create Education Background", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/education_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create education background" }, { "info": { "name": "Patch Education Background", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/education_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch education background" }, { "info": { "name": "Delete Education Background", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/education_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete education background" }, { "info": { "name": "Get Client And Family Background", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read client and family background from treatment plan" }, { "info": { "name": "Create Client And Family Background", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create client and family background" }, { "info": { "name": "Patch Client And Family Background", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing client and family background" }, { "info": { "name": "Delete Client And Family Background", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete client and family background" }, { "info": { "name": "Update Client Strengths", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/client_strengths/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Client Strengths" }, { "info": { "name": "Update Client Interests", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/client_interests/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Client Interests" }, { "info": { "name": "Get Client And Family Background Parents And Caregivers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/parents_and_caregivers/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all parents and caregivers from client and family background" }, { "info": { "name": "Create Client And Family Background Parents And Caregivers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/parents_and_caregivers/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create parent/caregiver" }, { "info": { "name": "Patch Client And Family Background Parents And Caregivers", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/parents_and_caregivers/:parent_and_caregiver_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" }, { "name": "parent_and_caregiver_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing parents and caregiver for client and family background" }, { "info": { "name": "Delete Client And Family Background Parents And Caregivers", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/parents_and_caregivers/:parent_and_caregiver_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" }, { "name": "parent_and_caregiver_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete parent and caregiver" }, { "info": { "name": "Get Client And Family Background Siblings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/siblings/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all siblings from client and family background" }, { "info": { "name": "Create Client And Family Background Sibling", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/siblings/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create sibling for client and family background" }, { "info": { "name": "Patch Client And Family Background Sibling", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/siblings/:sibling_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" }, { "name": "sibling_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing sibling for client and family background" }, { "info": { "name": "Delete Client And Family Background Sibling", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/client_and_family_background/:background_id/siblings/:sibling_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "background_id", "value": "", "type": "path" }, { "name": "sibling_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete sibling" }, { "info": { "name": "Get All Assessment Barriers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/barriers/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read all barriers" }, { "info": { "name": "Create Assessment Barrier", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/barriers/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create barrier for assessment" }, { "info": { "name": "Patch Assessment Barriers", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/barriers/:barrier_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "barrier_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch barrier" }, { "info": { "name": "Delete Assessment Barriers", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/barriers/:barrier_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" }, { "name": "barrier_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete barrier" }, { "info": { "name": "Create Assessment Summary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/summarize/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create summary for assessment" }, { "info": { "name": "Patch Assessment Summary", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/assessments/:assessment_id/summarize/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create summary for assessment" }, { "info": { "name": "Read All Symptoms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/symptoms/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all symptoms listed in a treatment plan" }, { "info": { "name": "Create Symptoms", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/symptoms/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create maladaptive symptoms for treatment plan" }, { "info": { "name": "Patch Symptom", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/symptoms/:symptom_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "symptom_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch maladaptive symptoms for treatment plan" }, { "info": { "name": "Delete Symptom", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/symptoms/:symptom_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "symptom_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete maladaptive symptoms for treatment plan" }, { "info": { "name": "Get Medical History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read medical history from treatment plan" }, { "info": { "name": "Create Medical History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create medical history" }, { "info": { "name": "Patch Medical History", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing medical history" }, { "info": { "name": "Delete Medical History", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete medical history" }, { "info": { "name": "Get Medical History Diagnoses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/:medical_history_id/diagnoses/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "medical_history_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all diagnoses from medical history" }, { "info": { "name": "Create Medical History Diagnosis", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/:medical_history_id/diagnoses/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "medical_history_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create diagnosis for medical history" }, { "info": { "name": "Patch Medical History Diagnosis", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/:medical_history_id/diagnoses/:diagnosis_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "medical_history_id", "value": "", "type": "path" }, { "name": "diagnosis_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing diagnosis for medical history" }, { "info": { "name": "Delete Medical History Diagnosis", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/medical_history/:medical_history_id/diagnoses/:diagnosis_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "medical_history_id", "value": "", "type": "path" }, { "name": "diagnosis_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete sibling" }, { "info": { "name": "Get Referral History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read referral history from treatment plan" }, { "info": { "name": "Create Referral History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create referral history" }, { "info": { "name": "Patch Referral History", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing referral history" }, { "info": { "name": "Delete Referral History", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete referral history" }, { "info": { "name": "Get Referral History Assessment Tools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/:referral_history_id/assessment_tools/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "referral_history_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all assessment tools for referral history" }, { "info": { "name": "Create Referral History Assessment Tool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/:referral_history_id/assessment_tools/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "referral_history_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create tool for referral history" }, { "info": { "name": "Patch Referral History Assessment Tool", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/:referral_history_id/assessment_tools/:tool_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "referral_history_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing tool for referral history" }, { "info": { "name": "Delete Referral History Assessment Tool", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/referral_history/:referral_history_id/assessment_tools/:tool_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "referral_history_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete assessment tool from referral history" }, { "info": { "name": "Get Treatment Recommendation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read treatment recommendation from treatment plan" }, { "info": { "name": "Create Treatment Recommendation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Treatment Recommendation" }, { "info": { "name": "Patch Treatment Recommendation", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing treatment recommendation" }, { "info": { "name": "Delete Treatment Recommendation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete treatment recommendation" }, { "info": { "name": "Get Treatment Recommendation Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/:treatment_recommendation_id/services/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "treatment_recommendation_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all services for treatment recommendation" }, { "info": { "name": "Create Treatment Recommendation Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/:treatment_recommendation_id/services/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "treatment_recommendation_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create service for treatment recommendation" }, { "info": { "name": "Patch Treatment Recommendation Service", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/:treatment_recommendation_id/services/:service_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "treatment_recommendation_id", "value": "", "type": "path" }, { "name": "service_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing service for treatment recommendation" }, { "info": { "name": "Delete Treatment Recommendation Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/treatment_recommendations/:treatment_recommendation_id/services/:service_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "treatment_recommendation_id", "value": "", "type": "path" }, { "name": "service_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete service" }, { "info": { "name": "Get Therapy History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Read therapy history from treatment plan" }, { "info": { "name": "Create Therapy History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create therapy history" }, { "info": { "name": "Patch Therapy History", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing therapy history" }, { "info": { "name": "Delete Therapy History", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete therapy history" }, { "info": { "name": "Get Therapy History Services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/:therapy_history_id/services/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "therapy_history_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all services for therapy history" }, { "info": { "name": "Create Therapy History Service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/:therapy_history_id/services/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "therapy_history_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Therapy History Service" }, { "info": { "name": "Patch Therapy History Service", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/:therapy_history_id/services/:service_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "therapy_history_id", "value": "", "type": "path" }, { "name": "service_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Therapy History Service" }, { "info": { "name": "Delete Therapy History Service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/therapy_history/:therapy_history_id/services/:service_id/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "therapy_history_id", "value": "", "type": "path" }, { "name": "service_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete service from therapy history" }, { "info": { "name": "Activate Treatment Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/activate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set this treatment plan to active" }, { "info": { "name": "Deactivate Treatment Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/deactivate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deactivate this treatment plan" }, { "info": { "name": "Set Treatment Plan Status To Edit", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/edit/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set Treatment Plan Status To Edit" }, { "info": { "name": "Get Treatment Plan Pdf", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/download/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch most recent PDF document for treatment plan\nPDF is returned as a pre-signed URL" }, { "info": { "name": "Activate Goal", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/activate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Activate Goal" }, { "info": { "name": "Deactivate Goal", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/deactivate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deactivate Goal" }, { "info": { "name": "Activate Target", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/:target_id/activate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Activate Target" }, { "info": { "name": "Deactivate Target", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/targets/:target_id/deactivate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deactivate Target" }, { "info": { "name": "Reassign Provider", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/reassign_provider/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reassign Provider" }, { "info": { "name": "Migrate Treatment Plan", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/migrate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Migrate Treatment Plan" }, { "info": { "name": "Create Hypothesized Function", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/hypothesized_functions/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Hypothesized Function" }, { "info": { "name": "Update Latest Hypothesized Function", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/hypothesized_functions/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Latest Hypothesized Function" }, { "info": { "name": "Delete Latest Hypothesized Function", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/hypothesized_functions/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Latest Hypothesized Function" }, { "info": { "name": "Update Treatment Plan Activation Log", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/activation_logs/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Treatment Plan Activation Log" }, { "info": { "name": "Migrate Goal", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/treatment_plans/:treatment_plan_id/goals/:goal_id/migrate/", "params": [ { "name": "treatment_plan_id", "value": "", "type": "path" }, { "name": "goal_id", "value": "", "type": "path" }, { "name": "preview", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Migrate Goal" } ] }, { "info": { "name": "treatment_plan_statuses", "type": "folder" }, "items": [ { "info": { "name": "Get Treatment Plan Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/treatment_plan_statuses/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return all treatment plan statuses.\nRoles allowed: pRBT, BCBA, Admin, CSM." }, { "info": { "name": "Create Treatment Plan Status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/treatment_plan_statuses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new treatment plan status." } ] }, { "info": { "name": "facilities", "type": "folder" }, "items": [ { "info": { "name": "Get Facilities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/facilities/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Facilities" }, { "info": { "name": "Create Facility", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/facilities/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Facility" } ] }, { "info": { "name": "payor", "type": "folder" }, "items": [ { "info": { "name": "Get Payors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/payors/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Payors" }, { "info": { "name": "Create Payor", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/payors/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Payor" }, { "info": { "name": "Get Payor", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/payors/:payor_id", "params": [ { "name": "payor_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Payor" }, { "info": { "name": "Update Payor", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/payors/:payor_id", "params": [ { "name": "payor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Payor" }, { "info": { "name": "Create Payor Contract", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/payors/:payor_id/contracts/", "params": [ { "name": "payor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Payor Contract" }, { "info": { "name": "Update Payor Contract", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/payors/:payor_id/contracts/:contract_id", "params": [ { "name": "payor_id", "value": "", "type": "path" }, { "name": "contract_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Payor Contract" }, { "info": { "name": "Delete Payor Contract", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/payors/:payor_id/contracts/:contract_id", "params": [ { "name": "payor_id", "value": "", "type": "path" }, { "name": "contract_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Payor Contract" }, { "info": { "name": "Create Service Code Description", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/payors/:payor_id/service_code_descriptions/", "params": [ { "name": "payor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Service Code Description" }, { "info": { "name": "Update Service Code Description", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/payors/:payor_id/service_code_descriptions/:service_code_description_id/", "params": [ { "name": "payor_id", "value": "", "type": "path" }, { "name": "service_code_description_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Service Code Description" } ] }, { "info": { "name": "behavior", "type": "folder" }, "items": [ { "info": { "name": "Get All Behaviors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/behaviors/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get All Behaviors" }, { "info": { "name": "Create Behavior", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/behaviors/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new behavior" }, { "info": { "name": "Fetch Goal Names", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/behaviors/:behavior_id/goal_names/", "params": [ { "name": "behavior_id", "value": "", "type": "path" }, { "name": "include_inactive", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reads goal names associated with a behavior" }, { "info": { "name": "Create Goal Name", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/behaviors/:behavior_id/goal_names/", "params": [ { "name": "behavior_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a goal name with a corresponding behavior" }, { "info": { "name": "Fetch All Goal Names", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/behaviors/goal_names/all/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch All Goal Names" }, { "info": { "name": "Fetch Goal Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/behaviors/:behavior_id/goal_names/:goal_name_id/", "params": [ { "name": "behavior_id", "value": "", "type": "path" }, { "name": "goal_name_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Goal Name" }, { "info": { "name": "Activate Goal Name", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/behaviors/:behavior_id/goal_names/:goal_name_id/activate/", "params": [ { "name": "behavior_id", "value": "", "type": "path" }, { "name": "goal_name_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Activate Goal Name" }, { "info": { "name": "Deactivate Goal Name", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/behaviors/:behavior_id/goal_names/:goal_name_id/deactivate/", "params": [ { "name": "behavior_id", "value": "", "type": "path" }, { "name": "goal_name_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deactivate Goal Name" } ] }, { "info": { "name": "parent_supervisions", "type": "folder" }, "items": [ { "info": { "name": "Fetch Parent Supervisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/parent_supervisions/", "params": [ { "name": "status_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "action_required", "value": "", "type": "query" }, { "name": "client_clinical_status", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Parent Supervisions" }, { "info": { "name": "Create Parent Supervision", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/parent_supervisions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Parent Supervision" }, { "info": { "name": "Get Parent Supervision", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Parent Supervision" }, { "info": { "name": "Update Parent Supervision", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Parent Supervision" }, { "info": { "name": "Delete Parent Supervision", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Parent Supervision" }, { "info": { "name": "Get Parent Supervisions With Claim History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/parent_supervisions/claim_history/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Parent Supervisions With Claim History" }, { "info": { "name": "Create Parent Supervision Goal Progress", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/goal_progress/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Parent Supervision Goal Progress" }, { "info": { "name": "Update Goal Progress", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/goal_progress/:goal_progress_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "goal_progress_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Goal Progress" }, { "info": { "name": "Delete Goal Progress", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/goal_progress/:goal_progress_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "goal_progress_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Goal Progress" }, { "info": { "name": "Create Trial", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Trial" }, { "info": { "name": "Patch Trial", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Trial" }, { "info": { "name": "Delete Trial", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Trial" }, { "info": { "name": "Create Duration Trial Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/duration_events/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Duration Trial Event" }, { "info": { "name": "Update Duration Trial Event", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/duration_events/:duration_event_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "duration_event_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Duration Trial Event" }, { "info": { "name": "Delete Duration Trial Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/duration_events/:duration_event_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "duration_event_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Duration Trial Event" }, { "info": { "name": "Create Rate Trial Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/rate_events/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Rate Trial Event" }, { "info": { "name": "Update Rate Trial Event", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/rate_events/:rate_event_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "rate_event_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Rate Trial Event" }, { "info": { "name": "Delete Rate Trial Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/target_evaluations/:trial_id/rate_events/:rate_event_id/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" }, { "name": "trial_id", "value": "", "type": "path" }, { "name": "rate_event_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Rate Trial Event" }, { "info": { "name": "Stop Parent Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/stop/", "headers": [ { "name": "x-forwarded-for", "value": "" } ], "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop Parent Supervision" }, { "info": { "name": "Get Utilization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/parent_supervisions/data/utilization/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Utilization" }, { "info": { "name": "Download Pdf", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/download/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download Pdf" }, { "info": { "name": "Make Parent Supervision Unbillable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/make_unbillable/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Parent Supervision Unbillable" }, { "info": { "name": "Make Parent Supervision Billable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/make_billable/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Parent Supervision Billable" }, { "info": { "name": "Edit Parent Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/edit/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Edit Parent Supervision" }, { "info": { "name": "Backdate Parent Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/parent_supervisions/:parent_supervision_id/backdate/", "params": [ { "name": "parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Backdate Parent Supervision" } ] }, { "info": { "name": "bt_supervisions", "type": "folder" }, "items": [ { "info": { "name": "Fetch All", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/bt_supervisions/", "params": [ { "name": "status_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "action_required", "value": "", "type": "query" }, { "name": "client_clinical_status", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch All" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/bt_supervisions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create" }, { "info": { "name": "Fetch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/bt_supervisions/:bt_supervision_id/", "params": [ { "name": "bt_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch" }, { "info": { "name": "Patch Basic Details", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/bt_supervisions/:bt_supervision_id/", "params": [ { "name": "bt_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Basic Details" }, { "info": { "name": "Delete Bt Supervision", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/bt_supervisions/:bt_supervision_id/", "params": [ { "name": "bt_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Bt Supervision" }, { "info": { "name": "Patch Data", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/bt_supervisions/:bt_supervision_id/data/", "params": [ { "name": "bt_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Data" }, { "info": { "name": "Stop", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/bt_supervisions/:bt_supervision_id/stop/", "params": [ { "name": "bt_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop" }, { "info": { "name": "Make Bt Supervision Unbillable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/bt_supervisions/:bt_supervision_id/make_unbillable/", "params": [ { "name": "bt_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Bt Supervision Unbillable" }, { "info": { "name": "Make Bt Supervision Billable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/bt_supervisions/:bt_supervision_id/make_billable/", "params": [ { "name": "bt_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Bt Supervision Billable" } ] }, { "info": { "name": "claims", "type": "folder" }, "items": [ { "info": { "name": "Generate Form 1500 Preview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/preview/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate Form 1500 Preview" }, { "info": { "name": "Get Claims", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/claims/", "params": [ { "name": "claim_id", "value": "", "type": "query" }, { "name": "session_id", "value": "", "type": "query" }, { "name": "client_supervision_id", "value": "", "type": "query" }, { "name": "parent_supervision_id", "value": "", "type": "query" }, { "name": "client_assessment_id", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "biller_id", "value": "", "type": "query" }, { "name": "payor_claim_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "secondary_status", "value": "", "type": "query" }, { "name": "date_start", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query" }, { "name": "clearing_house_claim_id", "value": "", "type": "query" }, { "name": "invoice_history_attributes_only", "value": "", "type": "query" }, { "name": "invoiceable_only", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Claims" }, { "info": { "name": "Create Claim", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Claim" }, { "info": { "name": "Resubmit Claim", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/:claim_id/resubmit/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resubmit Claim" }, { "info": { "name": "Get Claim", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/claims/:claim_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Claim" }, { "info": { "name": "Patch Claim", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/claims/:claim_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Claim" }, { "info": { "name": "Delete Claim", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/claims/:claim_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Claim" }, { "info": { "name": "Admin Delete Claim", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/claims/admin/:claim_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Admin-only force delete: remove a claim in ANY status, no status guardrails.\n\nUnlike ``delete_claim``, this skips ``validate_delete_request`` (which limits\ndeletion to Generated/Unbillable), so an admin can delete a claim regardless of\nstatus. It still refuses (409) when the claim has references the cascade cannot\nsafely remove -- an invoice, child claims, or EOB documents -- surfacing a clear\nmessage via ``assert_admin_deletable`` rather than a raw FK error. Because the row\nis about to be remov" }, { "info": { "name": "Admin Override Claim Status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/claims/admin/:claim_id/status/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Admin-only override of the claim status and the payment status.\n\nThis endpoint does not use the workflow validators. An admin can set\nthe status of a claim in almost any state. Some guards stay: the\nendpoint refuses (409) a change that can break an invoice, a payment,\nan EOB file, or a second submission (see assert_admin_status_overridable).\nEach change writes a claim_status_change_log row and a warning log line." }, { "info": { "name": "Create Follow Up Notes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/:claim_id/follow_up_notes/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Follow Up Notes" }, { "info": { "name": "Patch Follow Up Notes", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/claims/:claim_id/follow_up_notes/:claim_follow_up_notes_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" }, { "name": "claim_follow_up_notes_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Follow Up Notes" }, { "info": { "name": "Patch Claim Payment Status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/claims/:claim_id/payment_status/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Claim Payment Status" }, { "info": { "name": "Download Procedure Pdfs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/claims/:claim_id/procedures/download/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download Procedure Pdfs" }, { "info": { "name": "Create Service Line Payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/:claim_id/service_lines/:service_line_id/payments/", "params": [ { "name": "claim_id", "value": "", "type": "path" }, { "name": "service_line_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Service Line Payment" }, { "info": { "name": "Patch Service Line Payment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/claims/:claim_id/service_lines/:service_line_id/payments/:payment_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" }, { "name": "service_line_id", "value": "", "type": "path" }, { "name": "payment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Service Line Payment" }, { "info": { "name": "Delete Service Line Payment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/claims/:claim_id/service_lines/:service_line_id/payments/:payment_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" }, { "name": "service_line_id", "value": "", "type": "path" }, { "name": "payment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Service Line Payment" }, { "info": { "name": "Certify Claim", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/claims/:claim_id/certify_claim/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Certify Claim" }, { "info": { "name": "Create Eob Document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/:claim_id/eob_documents/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Eob Document" }, { "info": { "name": "Delete Eob Document", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/claims/:claim_id/eob_documents/:eob_document_id/", "params": [ { "name": "claim_id", "value": "", "type": "path" }, { "name": "eob_document_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Eob Document" }, { "info": { "name": "Submit Claim To Tebra", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/:claim_id/tebra/submit/", "params": [ { "name": "claim_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Submit Claim To Tebra" }, { "info": { "name": "Bulk Mark Notes Unbillable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claims/admin/bulk-unbillable", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Admin-only: create Unbillable claims from a CSV of notes.\n\nGuarded by JWT + admin role. Returns a summary with a per-row failure CSV;\nnever raises on individual bad rows." } ] }, { "info": { "name": "claim_invoices", "type": "folder" }, "items": [ { "info": { "name": "Generate Invoice Preview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claim_invoices/preview/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate Invoice Preview" }, { "info": { "name": "Get Invoices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/claim_invoices/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "date_due", "value": "", "type": "query" }, { "name": "sent", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Invoices" }, { "info": { "name": "Create Invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claim_invoices/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Invoice" }, { "info": { "name": "Get Invoice Payments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/payments/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Invoice Payments" }, { "info": { "name": "Create Invoice Payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/payments/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Invoice Payment" }, { "info": { "name": "Update Invoice Payment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/payments/:payment_id/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" }, { "name": "payment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Invoice Payment" }, { "info": { "name": "Delete Invoice Payment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/payments/:payment_id/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" }, { "name": "payment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Invoice Payment" }, { "info": { "name": "Send Invoice", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/send/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send Invoice" }, { "info": { "name": "Get Invoice", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Invoice" }, { "info": { "name": "Reset Invoice Sent Status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/reset_sent_status/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset Invoice Sent Status" }, { "info": { "name": "Download Invoice Pdf", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/download/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download Invoice Pdf" }, { "info": { "name": "Pay Invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/pay/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Pay Invoice" }, { "info": { "name": "Apply Discount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/discount/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Apply Discount" }, { "info": { "name": "Remove Discount", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/claim_invoices/:claim_invoice_id/discount/", "params": [ { "name": "claim_invoice_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Remove Discount" } ] }, { "info": { "name": "assessment_surveys", "type": "folder" }, "items": [ { "info": { "name": "Get Treaat Prediction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/assessment_surveys/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "model_path", "value": "", "type": "query" }, { "name": "metadata_path", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets the latest treaat prediction for a client based off of the latest assessment survey\n\nReturns\nArgs:\n assessment_survey_service:\n client_model_converter:\n provider_assignment_repo:\n client_id:\n provider:\n\nReturns:" }, { "info": { "name": "Send Assessment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/assessment_surveys/", "params": [ { "name": "model_path", "value": "", "type": "query" }, { "name": "metadata_path", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Sends an autism analytica survey to a client's BT\nOnly allows 1 survey to be sent per client ever for now\nby enforcing uniqueness on client_id in the database\nRoles allowed: pRBT, BCBA, Admin\nArgs:\n request:\n client_model_converter:\n assessment_survey_service:\n provider_assignment_repo:\n provider:\nReturns:\n Client (ClientSchema): client schema defined in pydantic\nRaises:\n 404: Client id not found" } ] }, { "info": { "name": "client_assessments", "type": "folder" }, "items": [ { "info": { "name": "Fetch Client Assessments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_assessments/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "service_code", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "action_required", "value": "", "type": "query" }, { "name": "client_clinical_status", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Client Assessments" }, { "info": { "name": "Create Client Assessment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/client_assessments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Client Assessment" }, { "info": { "name": "Fetch Client Assessment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Client Assessment" }, { "info": { "name": "Patch Client Assessment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Client Assessment" }, { "info": { "name": "Delete Client Assessment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Client Assessment" }, { "info": { "name": "Stop Client Assessment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/stop/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop Client Assessment" }, { "info": { "name": "Fetch Assessments With Claim History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_assessments/claim_history/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Assessments With Claim History" }, { "info": { "name": "Fetch Assisting Assessments With Claim History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_assessments/assisting_assessment_claim_history/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Assisting Assessments With Claim History" }, { "info": { "name": "Download Client Assessment Pdf", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/download/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download Client Assessment Pdf" }, { "info": { "name": "Make Assessment Unbillable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/make_unbillable/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Assessment Unbillable" }, { "info": { "name": "Make Assessment Billable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/make_billable/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Assessment Billable" }, { "info": { "name": "Edit Client Assessment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/edit/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Edit Client Assessment" }, { "info": { "name": "Backdate Client Assessment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/client_assessments/:client_assessment_id/backdate/", "params": [ { "name": "client_assessment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Backdate Client Assessment" } ] }, { "info": { "name": "payor_provider_credentials", "type": "folder" }, "items": [ { "info": { "name": "Fetch Payor Provider Credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/payor_provider_credentials/", "params": [ { "name": "active_only", "value": "", "type": "query" }, { "name": "payor_id", "value": "", "type": "query" }, { "name": "provider_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Payor Provider Credentials" }, { "info": { "name": "Create Payor Provider Credential", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/payor_provider_credentials/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Payor Provider Credential" }, { "info": { "name": "Patch Payor Provider Credential", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/payor_provider_credentials/:payor_provider_credential_id/", "params": [ { "name": "payor_provider_credential_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Payor Provider Credential" }, { "info": { "name": "Delete Payor Provider Credential", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/payor_provider_credentials/:payor_provider_credential_id/", "params": [ { "name": "payor_provider_credential_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Payor Provider Credential" } ] }, { "info": { "name": "cohorts", "type": "folder" }, "items": [ { "info": { "name": "Fetch Cohorts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/cohorts/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Cohorts" }, { "info": { "name": "Create Cohort", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/cohorts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Cohort" }, { "info": { "name": "Fetch Cohort", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/cohorts/:cohort_id/", "params": [ { "name": "cohort_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Cohort" }, { "info": { "name": "Update Cohort", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/cohorts/:cohort_id/", "params": [ { "name": "cohort_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Cohort" }, { "info": { "name": "Delete Cohort", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/cohorts/:cohort_id/", "params": [ { "name": "cohort_id", "value": "", "type": "path" }, { "name": "force", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Cohort" }, { "info": { "name": "Fetch Cohort Service Classes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/cohorts/service_classes/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Cohort Service Classes" } ] }, { "info": { "name": "email_cron_configs", "type": "folder" }, "items": [ { "info": { "name": "List Email Cron Configs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/email_cron_configs/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List Email Cron Configs" }, { "info": { "name": "Create Email Cron Config", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/email_cron_configs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Email Cron Config" }, { "info": { "name": "Get Email Cron Config", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/email_cron_configs/:config_id/", "params": [ { "name": "config_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Email Cron Config" }, { "info": { "name": "Update Email Cron Config", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/email_cron_configs/:config_id/", "params": [ { "name": "config_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Email Cron Config" }, { "info": { "name": "Delete Email Cron Config", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/email_cron_configs/:config_id/", "params": [ { "name": "config_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Email Cron Config" }, { "info": { "name": "Preview Email Cron Config", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/email_cron_configs/:config_id/preview/", "params": [ { "name": "config_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Preview Email Cron Config" } ] }, { "info": { "name": "client_cohort_assignments", "type": "folder" }, "items": [ { "info": { "name": "Fetch Client Cohort Assignments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/client_cohort_assignments/", "params": [ { "name": "client_id", "value": "", "type": "query" }, { "name": "cohort_id", "value": "", "type": "query" }, { "name": "active_only", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Client Cohort Assignments" }, { "info": { "name": "Create Client Cohort Assignment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/client_cohort_assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Client Cohort Assignment" }, { "info": { "name": "Update Client Cohort Assignment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/client_cohort_assignments/:client_cohort_assignment_id/", "params": [ { "name": "client_cohort_assignment_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Client Cohort Assignment" }, { "info": { "name": "Delete Client Cohort Assignment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/client_cohort_assignments/:client_cohort_assignment_id/", "params": [ { "name": "client_cohort_assignment_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Client Cohort Assignment" } ] }, { "info": { "name": "group_parent_supervisions", "type": "folder" }, "items": [ { "info": { "name": "Fetch Group Parent Supervisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "action_required", "value": "", "type": "query" }, { "name": "client_clinical_status", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Group Parent Supervisions" }, { "info": { "name": "Create Group Parent Supervision", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Group Parent Supervision" }, { "info": { "name": "Create Family Attendance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/family_attendance/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Family Attendance" }, { "info": { "name": "Create Family Training Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/family_attendance/:family_attendance_id/topics/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" }, { "name": "family_attendance_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Family Training Topic" }, { "info": { "name": "Delete Family Training Topic", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/family_attendance/:family_attendance_id/topics/:topic_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" }, { "name": "family_attendance_id", "value": "", "type": "path" }, { "name": "topic_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Family Training Topic" }, { "info": { "name": "Create Training Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/training_topics/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Training Topic" }, { "info": { "name": "Create Bulk Family Training Topics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/bulk_family_training_topics/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Bulk Family Training Topics" }, { "info": { "name": "Fetch Group Parent Supervision", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Group Parent Supervision" }, { "info": { "name": "Patch Group Parent Supervision", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch Group Parent Supervision" }, { "info": { "name": "Delete Group Parent Supervision", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Group Parent Supervision" }, { "info": { "name": "Fetch Training Topics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/training_topics/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Training Topics" }, { "info": { "name": "Update Family Attendance", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/family_attendance/:family_attendance_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" }, { "name": "family_attendance_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Family Attendance" }, { "info": { "name": "Delete Family Attendance", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/family_attendance/:family_attendance_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" }, { "name": "family_attendance_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Family Attendance" }, { "info": { "name": "Update Training Topic", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/training_topics/:training_topic_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" }, { "name": "training_topic_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Training Topic" }, { "info": { "name": "Delete Training Topic", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/training_topics/:training_topic_id/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" }, { "name": "training_topic_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Training Topic" }, { "info": { "name": "Fetch Group Parent Supervisions With Claim History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/claim_history/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch Group Parent Supervisions With Claim History" }, { "info": { "name": "Stop Group Parent Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/stop/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop Group Parent Supervision" }, { "info": { "name": "Download Group Parent Supervision Pdfs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/download/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Download Group Parent Supervision Pdfs" }, { "info": { "name": "Regenerate Group Parent Supervision Pdfs", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/pdf_regenerate/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Regenerate Group Parent Supervision Pdfs" }, { "info": { "name": "Edit Group Parent Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/edit/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Edit Group Parent Supervision" }, { "info": { "name": "Backdate Group Parent Supervision", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/backdate/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Backdate Group Parent Supervision" }, { "info": { "name": "Make Group Parent Supervision Unbillable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/make_unbillable/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Group Parent Supervision Unbillable" }, { "info": { "name": "Make Group Parent Supervision Billable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/group_parent_supervisions/:group_parent_supervision_id/make_billable/", "params": [ { "name": "group_parent_supervision_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make Group Parent Supervision Billable" } ] }, { "info": { "name": "provider_availability_records", "type": "folder" }, "items": [ { "info": { "name": "Get Provider Availability Records", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/provider_availability/", "params": [ { "name": "provider_id", "value": "", "type": "query" }, { "name": "timezone", "value": "", "type": "query" }, { "name": "day_of_week", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Provider Availability Records" }, { "info": { "name": "Create Provider Availability", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/provider_availability/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Provider Availability" }, { "info": { "name": "Update Provider Availability", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/provider_availability/:provider_availability_id/", "params": [ { "name": "provider_availability_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Provider Availability" }, { "info": { "name": "Delete Provider Availability", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/provider_availability/:provider_availability_id/", "params": [ { "name": "provider_availability_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Provider Availability" } ] }, { "info": { "name": "metrics", "type": "folder" }, "items": [ { "info": { "name": "Get Duration Aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/metrics/duration_aggregates/", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "client_id", "value": "", "type": "query" }, { "name": "exclude_clients_meeting_csn_criteria", "value": "", "type": "query" }, { "name": "exclude_zero_session_clients", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Duration Aggregates" } ] }, { "info": { "name": "onboarding_questionnaires", "type": "folder" }, "items": [ { "info": { "name": "Send Onboarding Questionnaire", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send onboarding questionnaire.\n\nCreates a questionnaire on first send for the (provider, client) pair. On resend,\nreturns the existing row for that pair. ``date_sent`` (stamped server-side as a\nUTC-aware datetime at send time) and ``date_sent_utc_offset`` are refreshed on resend\nexcept when the questionnaire is COMPLETED." }, { "info": { "name": "List Onboarding Questionnaires", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires", "params": [ { "name": "provider_id", "value": "", "type": "query", "description": "Filter by provider id (must be > 0)." }, { "name": "client_id", "value": "", "type": "query", "description": "Filter by client id (must be > 0)." }, { "name": "date_start", "value": "", "type": "query", "description": "Only include questionnaires with date_sent on/after this date." }, { "name": "date_end", "value": "", "type": "query", "description": "Only include questionnaires with date_sent on/before this date." }, { "name": "status", "value": "", "type": "query", "description": "Filter by questionnaire status." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List onboarding questionnaires (basic columns only, newest date_sent first).\n\nEach returned row also includes a lightweight ``provider`` and ``client`` summary\n(id/name/email) for the linked provider and client.\n\nFilter by ``provider_id``, ``client_id``, ``status``, and a ``date_sent`` window\n(``date_start`` inclusive, ``date_end`` inclusive of the whole day). The window is\npadded by one extra day on each side so records that land on an adjacent UTC day\n(because ``date_sent`` is stored as naive " }, { "info": { "name": "Get Onboarding Questionnaire By Provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/by_provider/:provider_id", "params": [ { "name": "provider_id", "value": "", "type": "path", "description": "Provider id (must be > 0)" }, { "name": "client_id", "value": "", "type": "query", "description": "When set, narrows the result to this provider and client (at most one row). When omitted, returns every questionnaire for the provider." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "All questionnaires for the provider (newest date_sent first).\n\nA provider usually has several clients assigned, so this returns every questionnaire\nat once; pass ``client_id`` to narrow to a single client.\n\nCallers with broad visibility (an overriding role, or the provider looking up their\nown id) get the real outcome: an empty list when none exists and ``404`` if the\nprovider is missing. Any other caller only sees the questionnaires they are authorized\nto read (an active provider assignment to " }, { "info": { "name": "Get Onboarding Questionnaire By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Full questionnaire with nested sections, or 404 if not found.\n403 unless the caller holds an overriding role, is the assigned provider, or has\nan active provider assignment to the questionnaire's client." }, { "info": { "name": "Patch Onboarding Questionnaire General Info", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/general_info", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Merge partial general info for the questionnaire (omit fields to leave unchanged).\n403 if caller is not the assigned provider; 404 if questionnaire missing." }, { "info": { "name": "Patch Onboarding Questionnaire Insurance Primary", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/insurance/primary", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Merge partial primary insurance (insurance_type PRIMARY). 403/404 like general_info." }, { "info": { "name": "Patch Onboarding Questionnaire Insurance Secondary", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/insurance/secondary", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Merge partial secondary insurance (insurance_type SECONDARY). 403/404 like general_info." }, { "info": { "name": "Delete Onboarding Questionnaire Insurance Secondary", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/insurance/secondary", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Drop secondary insurance row. 204 either way; 403/404 same as PATCH insurance." }, { "info": { "name": "Patch Onboarding Questionnaire Insurance Preferences", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/insurance/preferences", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Save no-secondary choice; clears secondary row when true. 403/404 like other insurance PATCH." }, { "info": { "name": "Extract Onboarding Questionnaire Insurance Card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/insurance-card/extract", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Extract insurance fields from saved front/back card images (prefill only; not persisted).\n403 if caller is not the assigned provider; 404 if questionnaire missing." }, { "info": { "name": "Create Onboarding Questionnaire Insurance Card Extraction Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/insurance-card/extraction-jobs", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create async insurance card extraction job; poll GET extraction-jobs/{job_id} for results." }, { "info": { "name": "Get Onboarding Questionnaire Insurance Card Extraction Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/insurance-card/extraction-jobs/:job_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" }, { "name": "job_id", "value": "", "type": "path", "description": "Extraction job id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Poll extraction job status and result. 403 unless the caller holds an overriding\nrole, is the assigned provider, or has an active provider assignment to the\nquestionnaire's client." }, { "info": { "name": "Patch referral section", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/referral", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Merge referral fields; lists replace the whole list ([] clears). Empty body with no saved row returns the same empty shell as GET; with a saved row, returns the current section unchanged." }, { "info": { "name": "Patch agreement section", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/agreement", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially updates agreement; empty body is a no-op. Idempotent re-PATCH of the same\nvalues does not error. 403 if caller is not the assigned provider; 404 if questionnaire\nid is unknown; 400 when questionnaire status is COMPLETED." }, { "info": { "name": "Submit Onboarding Questionnaire", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/submit", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate required sections then set status to COMPLETED (idempotent if already done).\n403 if caller is not the assigned provider; 404 if questionnaire missing; 400 if\nany required section is incomplete." }, { "info": { "name": "Update Onboarding Questionnaire Status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/status", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Forward-only status chain (STARTED→IN_PROGRESS); same status is a no-op. Completing\na questionnaire is not allowed here — use POST /{id}/submit, which validates required\nsections and records date_concluded; requesting COMPLETED returns 400. 400/422/403/404\non bad transition, invalid stored status, wrong provider, or id." }, { "info": { "name": "List Onboarding Questionnaire Documents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/documents/", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Metadata-only list, oldest first; empty list if none. No presigned URLs here (use\nGET by document id). 404/422 if questionnaire invalid. 403 unless the caller holds an\noverriding role, is the assigned provider, or has an active provider assignment to the\nquestionnaire's client." }, { "info": { "name": "Upload Onboarding Questionnaire Document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/documents/", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Upload PDF/PNG/JPEG to S3 and save metadata (title, type, size rules in service).\nReturns the full questionnaire document list (oldest first), same shape as GET\n``.../documents/``, so clients can refresh UI without a follow-up list call.\n404/422/400/403 on bad questionnaire id, validation, or wrong provider." }, { "info": { "name": "Get Onboarding Questionnaire Document", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/documents/:document_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" }, { "name": "document_id", "value": "", "type": "path", "description": "Questionnaire document id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "One document's metadata plus a presigned URL; 404 unless document belongs to this\nquestionnaire (no cross-scope leaks). 422 on non-positive ids. 403 unless the caller\nholds an overriding role, is the assigned provider, or has an active provider\nassignment to the questionnaire's client." }, { "info": { "name": "Delete Onboarding Questionnaire Document", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/onboarding_questionnaires/:questionnaire_id/documents/:document_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Onboarding questionnaire id (must be > 0)" }, { "name": "document_id", "value": "", "type": "path", "description": "Questionnaire document id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete DB row then best-effort S3 cleanup; extraction jobs referencing the document\nare removed first. Returns 204 once the DB row is gone; S3 failures are logged only.\n404/422/403 on missing scope, bad ids, or wrong provider." } ] }, { "info": { "name": "intake_questionnaires", "type": "folder" }, "items": [ { "info": { "name": "Send Intake Questionnaire", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/send", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an intake questionnaire for the (provider, client) pair.\n\nCallers without an overriding role may only send a questionnaire for themselves\n(403 when ``provider_id`` is someone else's) — the target provider is taken from the\nrequest body, so this prevents a holder of ``post:intake_questionnaires:send`` from\ncreating questionnaires for arbitrary (provider, client) pairs.\n\n400 when the provider is not a practicing guardian for the client, the provider's\nonboarding questionnaire is not COMPLET" }, { "info": { "name": "List Intake Questionnaires", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/intake_questionnaires", "params": [ { "name": "provider_id", "value": "", "type": "query", "description": "Filter by provider id (must be > 0)." }, { "name": "client_id", "value": "", "type": "query", "description": "Filter by client id (must be > 0)." }, { "name": "date_start", "value": "", "type": "query", "description": "Only include questionnaires with date_sent on/after this date." }, { "name": "date_end", "value": "", "type": "query", "description": "Only include questionnaires with date_sent on/before this date." }, { "name": "status", "value": "", "type": "query", "description": "Filter by questionnaire status." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List intake questionnaires (basic columns only, newest date_sent first).\n\nEach returned row also includes a lightweight ``provider`` and ``client`` summary\n(id/name/email) for the linked provider and client.\n\nFilter by ``provider_id``, ``client_id``, ``status``, and a ``date_sent`` window\n(``date_start`` inclusive, ``date_end`` inclusive of the whole day). The window is\npadded by one extra day on each side so records that land on an adjacent UTC day\n(because ``date_sent`` is stored as naive UTC " }, { "info": { "name": "Get Intake Questionnaires By Provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/intake_questionnaires/by_provider/:provider_id", "params": [ { "name": "provider_id", "value": "", "type": "path", "description": "Provider id (must be > 0)" }, { "name": "client_id", "value": "", "type": "query", "description": "When set, narrows the result to this provider and client (at most one row). When omitted, returns every questionnaire for the provider." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "All intake questionnaires for a provider (basic columns only, newest first).\n\nA provider usually has several clients assigned, so this returns every questionnaire\nat once; pass ``client_id`` to narrow to a single client. Related sections (general\ninfo, medical info, etc.) are omitted.\n\nCallers with broad visibility (an overriding role, or the provider looking up their\nown id) get the real outcome: an empty list when none exists and ``404`` if the\nprovider is missing. Any other caller only sees t" }, { "info": { "name": "Get Intake Questionnaire By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Full questionnaire with nested sections; 404 if not found.\n\nCallers without an overriding role may only read questionnaires sent to them (403\notherwise). Sections and collections that have no rows yet (e.g. ``medical_info``,\n``referrals``) are returned as ``null``." }, { "info": { "name": "Update Intake Questionnaire", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Patch top-level flags (``has_no_medications``, ``has_no_therapies``,\n``not_attending_school``) on the questionnaire; 404 if not found.\n\nOnly the provider the questionnaire was sent to may update it (403 otherwise). Only\nfields present in the request body are updated; omitted fields are unchanged." }, { "info": { "name": "Update Intake Questionnaire General Info", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/general_info", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partial PATCH for general info; 403/404/400 per edit guard." }, { "info": { "name": "Update Intake Questionnaire Education Info", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/education_info", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partial PATCH for education info; upserts row and clears not_attending_school." }, { "info": { "name": "Update Intake Questionnaire Medical Info", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medical_info", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partial PATCH for medical info; upserts the parent row." }, { "info": { "name": "Create Intake Questionnaire Medical Info Diagnosis", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medical_info/diagnosis", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a medical info diagnosis row for an intake questionnaire.\n\nOnly the provider the questionnaire was sent to may create it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowed (400). Duplicate ``diagnosis_name`` values return 409." }, { "info": { "name": "Update Intake Questionnaire Medical Info Diagnosis", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medical_info/diagnosis/:diagnosis_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "diagnosis_id", "value": "", "type": "path", "description": "Diagnosis id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partial PATCH for one medical info diagnosis row.\n\nOnly the provider the questionnaire was sent to may update it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no diagnosis with ``diagnosis_id`` belongs to\nit. Once the questionnaire is COMPLETED no further changes are allowed (400)." }, { "info": { "name": "Delete Intake Questionnaire Medical Info Diagnosis", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medical_info/diagnosis/:diagnosis_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "diagnosis_id", "value": "", "type": "path", "description": "Diagnosis id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete one medical info diagnosis row.\n\nOnly the provider the questionnaire was sent to may delete it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no diagnosis with ``diagnosis_id`` belongs to\nit. Once the questionnaire is COMPLETED no deletes are allowed (400)." }, { "info": { "name": "Create Intake Questionnaire Medical Info Selection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medical_info/selection", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create one medical info multi-select value (early intervention, pregnancy issue, or regression).\n\nOnly the provider the questionnaire was sent to may create it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowed (400). Duplicate values and ``None`` conflicts return 409." }, { "info": { "name": "Delete Intake Questionnaire Medical Info Selection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medical_info/selection/:selection_type/:selection_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "selection_type", "value": "", "type": "path", "description": "Medical info selection type" }, { "name": "selection_id", "value": "", "type": "path", "description": "Selection id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete one medical info multi-select value.\n\nOnly the provider the questionnaire was sent to may delete it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no row with ``selection_id`` belongs to it\nfor ``selection_type``. Once the questionnaire is COMPLETED no deletes are allowed\n(400)." }, { "info": { "name": "Update Intake Questionnaire Family", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partial PATCH for family; upserts the parent row." }, { "info": { "name": "Create Intake Questionnaire Family Member", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/member", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Intake Questionnaire Family Member" }, { "info": { "name": "Update Intake Questionnaire Family Member", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/member/:member_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "member_id", "value": "", "type": "path", "description": "Family member id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Intake Questionnaire Family Member" }, { "info": { "name": "Delete Intake Questionnaire Family Member", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/member/:member_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "member_id", "value": "", "type": "path", "description": "Family member id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Intake Questionnaire Family Member" }, { "info": { "name": "Create Intake Questionnaire Family Client Sibling", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/client_sibling", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Intake Questionnaire Family Client Sibling" }, { "info": { "name": "Update Intake Questionnaire Family Client Sibling", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/client_sibling/:sibling_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "sibling_id", "value": "", "type": "path", "description": "Client sibling id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Intake Questionnaire Family Client Sibling" }, { "info": { "name": "Delete Intake Questionnaire Family Client Sibling", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/client_sibling/:sibling_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "sibling_id", "value": "", "type": "path", "description": "Client sibling id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Intake Questionnaire Family Client Sibling" }, { "info": { "name": "Create Intake Questionnaire Family Additional Info", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/additional_info", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Intake Questionnaire Family Additional Info" }, { "info": { "name": "Delete Intake Questionnaire Family Additional Info", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/family/additional_info/:item_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "item_id", "value": "", "type": "path", "description": "Additional info id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Intake Questionnaire Family Additional Info" }, { "info": { "name": "Create Intake Questionnaire Referral", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/referral", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a referral for an intake questionnaire.\n\nA new referral row is created from the fields present in the body; every field is\noptional, so an empty/all-null body still creates a row with all columns NULL.\n\nOnly the provider the questionnaire was sent to may create it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowed (400)." }, { "info": { "name": "Update Intake Questionnaire Referral", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/referral/:referral_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "referral_id", "value": "", "type": "path", "description": "Referral id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a referral by id for an intake questionnaire.\n\nOnly fields present in the body are applied (null clears the column); omitted fields\nare left untouched.\n\nOnly the provider the questionnaire was sent to may update it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no referral with ``referral_id`` belongs to\nit. Once the questionnaire is COMPLETED no further changes are allowed (400)." }, { "info": { "name": "Delete Intake Questionnaire Referral", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/referral/:referral_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "referral_id", "value": "", "type": "path", "description": "Referral id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a referral by id from an intake questionnaire.\n\nOnly the provider the questionnaire was sent to may delete it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no referral with ``referral_id`` belongs to\nit. Once the questionnaire is COMPLETED no deletes are allowed (400)." }, { "info": { "name": "Create Intake Questionnaire Medication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medication", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a medication for an intake questionnaire.\n\nA new medication row is created from the fields present in the body; every field is\noptional, so an empty/all-null body still creates a row with all columns NULL.\n\nOnly the provider the questionnaire was sent to may create it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowed (400)." }, { "info": { "name": "Update Intake Questionnaire Medication", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medication/:medication_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "medication_id", "value": "", "type": "path", "description": "Medication id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a medication by id for an intake questionnaire.\n\nOnly fields present in the body are applied (null clears the column); omitted fields\nare left untouched.\n\nOnly the provider the questionnaire was sent to may update it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no medication with ``medication_id`` belongs\nto it. Once the questionnaire is COMPLETED no further changes are allowed (400)." }, { "info": { "name": "Delete Intake Questionnaire Medication", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medication/:medication_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "medication_id", "value": "", "type": "path", "description": "Medication id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a medication by id from an intake questionnaire.\n\nOnly the provider the questionnaire was sent to may delete it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no medication with ``medication_id`` belongs\nto it. Once the questionnaire is COMPLETED no deletes are allowed (400)." }, { "info": { "name": "Create Intake Questionnaire Therapy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/therapy", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a therapy for an intake questionnaire.\n\nA new therapy row is created from the fields present in the body; every field is\noptional, so an empty/all-null body still creates a row with all nullable columns\nNULL.\n\nOnly the provider the questionnaire was sent to may create it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowed (400)." }, { "info": { "name": "Update Intake Questionnaire Therapy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/therapy/:therapy_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "therapy_id", "value": "", "type": "path", "description": "Therapy id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a therapy by id for an intake questionnaire.\n\nOnly fields present in the body are applied (null clears a nullable column); omitted\nfields are left untouched. ``do_not_share_info_with_provider`` cannot be set to\n``null`` (422).\n\nOnly the provider the questionnaire was sent to may update it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no therapy with ``therapy_id`` belongs to it.\nOnce the questionnaire is COMPLETED no further changes are allowed (400)." }, { "info": { "name": "Delete Intake Questionnaire Therapy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/therapy/:therapy_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "therapy_id", "value": "", "type": "path", "description": "Therapy id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a therapy by id from an intake questionnaire.\n\nOnly the provider the questionnaire was sent to may delete it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no therapy with ``therapy_id`` belongs to it.\nOnce the questionnaire is COMPLETED no deletes are allowed (400)." }, { "info": { "name": "Delete All Intake Questionnaire Medications", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/medication/all", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete all medications for an intake questionnaire and set ``has_no_medications``.\n\nRemoves every medication row on the questionnaire and sets its ``has_no_medications``\nflag to ``True`` in the same transaction, returning the updated questionnaire.\nIdempotent when there are no medications to begin with.\n\nOnly the provider the questionnaire was sent to may delete them (403 otherwise); 404\nif the questionnaire does not exist. Once the questionnaire is COMPLETED no deletes\nare allowed (400)." }, { "info": { "name": "Delete All Intake Questionnaire Therapies", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/therapy/all", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete all therapies for an intake questionnaire and set ``has_no_therapies``.\n\nRemoves every therapy row on the questionnaire and sets its ``has_no_therapies`` flag\nto ``True`` in the same transaction, returning the updated questionnaire. Idempotent\nwhen there are no therapies to begin with.\n\nOnly the provider the questionnaire was sent to may delete them (403 otherwise); 404\nif the questionnaire does not exist. Once the questionnaire is COMPLETED no deletes\nare allowed (400)." }, { "info": { "name": "Upsert Intake Questionnaire Child Info", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/child_info", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or update the questionnaire's 1:1 child info row.\n\nThe only updatable field is ``child_behavior_issues``. The row is created on demand if\nit does not exist yet, otherwise updated; fields omitted from the body are left\nuntouched.\n\nOnly the provider the questionnaire was sent to may upsert it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowed (400)." }, { "info": { "name": "Create Intake Questionnaire Child Info Background", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/child_info/background", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a child info background for an intake questionnaire.\n\nA new background row is created from the fields present in the body; every field is\noptional, so an empty/all-null body still creates a row with all columns NULL. The\nquestionnaire's 1:1 child info row is created automatically if it does not exist yet.\n\nOnly the provider the questionnaire was sent to may create it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowe" }, { "info": { "name": "Delete Intake Questionnaire Child Info Background", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/child_info/background/:background_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "background_id", "value": "", "type": "path", "description": "Background id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a child info background by id from an intake questionnaire.\n\nOnly the provider the questionnaire was sent to may delete it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no background with ``background_id`` belongs to\nit. Once the questionnaire is COMPLETED no deletes are allowed (400)." }, { "info": { "name": "Create Intake Questionnaire Child Info Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/child_info/schedule", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a child info schedule for an intake questionnaire.\n\nA new schedule row is created from the fields present in the body; every field is\noptional, so an empty/all-null body still creates a row with all columns NULL. The\nquestionnaire's 1:1 child info row is created automatically if it does not exist yet.\n\nOnly the provider the questionnaire was sent to may create it (403 otherwise); 404 if\nthe questionnaire does not exist. Once the questionnaire is COMPLETED no further\nchanges are allowed (4" }, { "info": { "name": "Delete Intake Questionnaire Child Info Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/child_info/schedule/:schedule_id", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" }, { "name": "schedule_id", "value": "", "type": "path", "description": "Schedule id (must be > 0)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a child info schedule by id from an intake questionnaire.\n\nOnly the provider the questionnaire was sent to may delete it (403 otherwise). 404 if\nthe questionnaire does not exist, or if no schedule with ``schedule_id`` belongs to\nit. Once the questionnaire is COMPLETED no deletes are allowed (400)." }, { "info": { "name": "Submit Intake Questionnaire", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/intake_questionnaires/:questionnaire_id/submit", "params": [ { "name": "questionnaire_id", "value": "", "type": "path", "description": "Intake questionnaire id (must be > 0)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate a completed intake questionnaire and mark it submitted." } ] }, { "info": { "name": "field_templates", "type": "folder" }, "items": [ { "info": { "name": "List Fields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/field_templates/fields/", "params": [ { "name": "resource", "value": "", "type": "query", "description": "Filter to fields belonging to this resource value." }, { "name": "with_template", "value": "", "type": "query", "description": "Append each field's saved template content." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List catalog fields, optionally filtered by resource and enriched with templates." }, { "info": { "name": "Get Field Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/field_templates/:identifier/", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the template bound to a field by its unique identifier (template is null if unset)." }, { "info": { "name": "Upsert Field Template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/field_templates/:identifier/", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create or replace the template bound to a field (sanitized server-side)." } ] }, { "info": { "name": "feature_flags", "type": "folder" }, "items": [ { "info": { "name": "Get Feature Flags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/feature_flags/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Feature Flags" }, { "info": { "name": "Set Feature Flag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/feature_flags/:key", "params": [ { "name": "key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set Feature Flag" } ] }, { "info": { "name": "stripe", "type": "folder" }, "items": [ { "info": { "name": "Handle Stripe Webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/stripe/" }, "docs": "Handle Stripe Webhook" } ] } ], "bundled": true }