{ "item": [ { "name": "Organization", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "The organization this credential acts for.", "request": { "name": "The organization this credential acts for.", "description": {}, "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Every organization this credential holds an approved grant to.", "request": { "name": "Every organization this credential holds an approved grant to.", "description": {}, "url": { "path": [ "v1", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Catalog", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "The formulary a case can request from.", "request": { "name": "The formulary a case can request from.", "description": {}, "url": { "path": [ "v1", "medications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "The pharmacies that can fill an order.", "request": { "name": "The pharmacies that can fill an order.", "description": {}, "url": { "path": [ "v1", "pharmacies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "The states this organization can serve.", "request": { "name": "The states this organization can serve.", "description": {}, "url": { "path": [ "v1", "states" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Patients", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Create a patient.", "request": { "name": "Create a patient.", "description": {}, "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"sex_at_birth\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"line2\": \"\"\n },\n \"external_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List patients, optionally by the caller's own identifier.", "request": { "name": "List patients, optionally by the caller's own identifier.", "description": {}, "url": { "path": [ "v1", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" }, { "disabled": false, "key": "external_id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a patient.", "request": { "name": "Retrieve a patient.", "description": {}, "url": { "path": [ "v1", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update a patient.", "request": { "name": "Update a patient.", "description": {}, "url": { "path": [ "v1", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"sex_at_birth\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"line2\": \"\"\n },\n \"external_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Every case filed for a patient.", "request": { "name": "Every case filed for a patient.", "description": {}, "url": { "path": [ "v1", "patients", ":id", "cases" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" }, { "disabled": false, "key": "status", "value": "" }, { "disabled": false, "key": "patient", "value": "" }, { "disabled": false, "key": "created_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Start an export of everything held for a patient.", "request": { "name": "Start an export of everything held for a patient.", "description": {}, "url": { "path": [ "v1", "patients", ":id", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Check an export and collect its link.", "request": { "name": "Check an export and collect its link.", "description": {}, "url": { "path": [ "v1", "patients", ":id", "exports", ":job" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "job", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Check an export by its own id.", "request": { "name": "Check an export by its own id.", "description": {}, "url": { "path": [ "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Download the bundle an export assembled, as often as you need until it expires.", "request": { "name": "Download the bundle an export assembled, as often as you need until it expires.", "description": {}, "url": { "path": [ "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Request erasure of a patient's contact data.", "request": { "name": "Request erasure of a patient's contact data.", "description": {}, "url": { "path": [ "v1", "patients", ":id", "deletion_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Files", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Reserve a file against a patient and get a URL to upload its bytes to.", "request": { "name": "Reserve a file against a patient and get a URL to upload its bytes to.", "description": {}, "url": { "path": [ "v1", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient\": \"\",\n \"kind\": \"\",\n \"filename\": \"\",\n \"mime\": \"\",\n \"size\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Confirm the bytes were uploaded, filing the document and giving it its own id.", "request": { "name": "Confirm the bytes were uploaded, filing the document and giving it its own id.", "description": {}, "url": { "path": [ "v1", "files", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient\": \"\",\n \"kind\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a confirmed file's metadata.", "request": { "name": "Retrieve a confirmed file's metadata.", "description": {}, "url": { "path": [ "v1", "files", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete a sandbox file that is not attached to a case.", "request": { "name": "Delete a sandbox file that is not attached to a case.", "description": {}, "url": { "path": [ "v1", "files", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Consents", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Record a consent the patient accepted.", "request": { "name": "Record a consent the patient accepted.", "description": {}, "url": { "path": [ "v1", "patients", ":id", "consents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"\",\n \"version\": \"\",\n \"accepted_at\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Every consent recorded for a patient.", "request": { "name": "Every consent recorded for a patient.", "description": {}, "url": { "path": [ "v1", "patients", ":id", "consents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Cases", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "File a case for clinician review.", "request": { "name": "File a case for clinician review.", "description": {}, "url": { "path": [ "v1", "cases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient\": \"\",\n \"requested_medications\": [\n {\n \"medication_id\": \"\",\n \"quantity\": \"\",\n \"refills\": \"\",\n \"days_supply\": \"\",\n \"directions\": \"\",\n \"pharmacy_notes\": \"\",\n \"pharmacy_id\": \"\",\n \"no_substitutions\": \"\"\n }\n ],\n \"answers\": [\n {\n \"id\": \"\",\n \"question\": \"\",\n \"answer\": \"\",\n \"type\": \"\",\n \"important\": \"\",\n \"critical\": \"\",\n \"displayed_options\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"consent_ids\": [\n \"\"\n ],\n \"files\": [\n \"\",\n \"\"\n ],\n \"hold\": false,\n \"external_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List cases.", "request": { "name": "List cases.", "description": {}, "url": { "path": [ "v1", "cases" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" }, { "disabled": false, "key": "status", "value": "" }, { "disabled": false, "key": "patient", "value": "" }, { "disabled": false, "key": "created_after", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a case.", "request": { "name": "Retrieve a case.", "description": {}, "url": { "path": [ "v1", "cases", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Cancel a case that has not been decided.", "request": { "name": "Cancel a case that has not been decided.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Queue a case that was held at creation.", "request": { "name": "Queue a case that was held at creation.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "release_hold" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Every event emitted for a case.", "request": { "name": "Every event emitted for a case.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Every status a case has held, oldest first.", "request": { "name": "Every status a case has held, oldest first.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "status_history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Messages", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "The message thread on a case.", "request": { "name": "The message thread on a case.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Post a message to a case as the patient or as the integration.", "request": { "name": "Post a message to a case as the patient or as the integration.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"text\": \"\",\n \"files\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Prescriptions", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "What the clinician prescribed on a case.", "request": { "name": "What the clinician prescribed on a case.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Orders", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "The fulfilment orders raised from a case.", "request": { "name": "The fulfilment orders raised from a case.", "description": {}, "url": { "path": [ "v1", "cases", ":id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve an order.", "request": { "name": "Retrieve an order.", "description": {}, "url": { "path": [ "v1", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "List webhook endpoints.", "request": { "name": "List webhook endpoints.", "description": {}, "url": { "path": [ "v1", "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create a webhook endpoint and return its signing secret once.", "request": { "name": "Create a webhook endpoint and return its signing secret once.", "description": {}, "url": { "path": [ "v1", "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\"\n ],\n \"include_resource\": false,\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a webhook endpoint.", "request": { "name": "Retrieve a webhook endpoint.", "description": {}, "url": { "path": [ "v1", "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update a webhook endpoint.", "request": { "name": "Update a webhook endpoint.", "description": {}, "url": { "path": [ "v1", "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\"\n ],\n \"include_resource\": false,\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete a webhook endpoint.", "request": { "name": "Delete a webhook endpoint.", "description": {}, "url": { "path": [ "v1", "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Rotate the signing secret, keeping the previous one valid for 24 hours.", "request": { "name": "Rotate the signing secret, keeping the previous one valid for 24 hours.", "description": {}, "url": { "path": [ "v1", "webhook_endpoints", ":id", "rotate_secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Every delivery attempt made to an endpoint.", "request": { "name": "Every delivery attempt made to an endpoint.", "description": {}, "url": { "path": [ "v1", "webhook_endpoints", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" }, { "disabled": false, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Events", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Poll for events, the backstop when a webhook was missed.", "request": { "name": "Poll for events, the backstop when a webhook was missed.", "description": {}, "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" }, { "disabled": false, "key": "since", "value": "" }, { "disabled": false, "key": "type", "value": "" }, { "disabled": false, "key": "include_resource", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve an event.", "request": { "name": "Retrieve an event.", "description": {}, "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Queue an event for delivery again.", "request": { "name": "Queue an event for delivery again.", "description": {}, "url": { "path": [ "v1", "events", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Billing", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "What this organization has been charged for over a period, by kind.", "request": { "name": "What this organization has been charged for over a period, by kind.", "description": {}, "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "" }, { "disabled": false, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "The invoices raised against this integration, newest first.", "request": { "name": "The invoices raised against this integration, newest first.", "description": {}, "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "One invoice, with the charges it was built from.", "request": { "name": "One invoice, with the charges it was built from.", "description": {}, "url": { "path": [ "v1", "invoices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Visits", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Bookable slots for a patient's state, with how many clinicians are free at each.", "request": { "name": "Bookable slots for a patient's state, with how many clinicians are free at each.", "description": {}, "url": { "path": [ "v1", "visits", "slots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "state", "value": "", "description": "(Required) " }, { "disabled": false, "key": "treatment", "value": "" }, { "disabled": false, "key": "from", "value": "", "description": "(Required) " }, { "disabled": false, "key": "to", "value": "", "description": "(Required) " } ], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Book a video visit for a patient.", "request": { "name": "Book a video visit for a patient.", "description": {}, "url": { "path": [ "v1", "visits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient\": \"\",\n \"slot_start\": \"\",\n \"case\": \"\",\n \"audio_only\": false,\n \"treatment\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve a visit.", "request": { "name": "Retrieve a visit.", "description": {}, "url": { "path": [ "v1", "visits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Cancel a visit that has not started.", "request": { "name": "Cancel a visit that has not started.", "description": {}, "url": { "path": [ "v1", "visits", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Move a visit to another slot, keeping its id.", "request": { "name": "Move a visit to another slot, keeping its id.", "description": {}, "url": { "path": [ "v1", "visits", ":id", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"slot_start\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Mint the short-lived link the patient joins the visit through.", "request": { "name": "Mint the short-lived link the patient joins the visit through.", "description": {}, "url": { "path": [ "v1", "visits", ":id", "join" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Realtime", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Mint a subscribe-only realtime token for this integration and organization.", "request": { "name": "Mint a subscribe-only realtime token for this integration and organization.", "description": {}, "url": { "path": [ "v1", "realtime", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Test mode", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Decide a sandbox case as the clinician would.", "request": { "name": "Decide a sandbox case as the clinician would.", "description": {}, "url": { "path": [ "v1", "test", "cases", ":id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"decision\": \"\",\n \"plan\": [\n {\n \"medication_id\": \"\",\n \"quantity\": \"\",\n \"refills\": \"\",\n \"days_supply\": \"\",\n \"directions\": \"\",\n \"pharmacy_notes\": \"\",\n \"pharmacy_id\": \"\",\n \"dispensable\": true\n }\n ],\n \"note\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Reply to a sandbox case as the clinician.", "request": { "name": "Reply to a sandbox case as the clinician.", "description": {}, "url": { "path": [ "v1", "test", "cases", ":id", "clinician_message" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"text\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Advance a sandbox case's order to shipped.", "request": { "name": "Advance a sandbox case's order to shipped.", "description": {}, "url": { "path": [ "v1", "test", "cases", ":id", "ship" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"tracking_url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Advance a sandbox case's order to delivered.", "request": { "name": "Advance a sandbox case's order to delivered.", "description": {}, "url": { "path": [ "v1", "test", "cases", ":id", "deliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Block a sandbox case's order with a reason.", "request": { "name": "Block a sandbox case's order with a reason.", "description": {}, "url": { "path": [ "v1", "test", "cases", ":id", "block" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Fail a sandbox case's order.", "request": { "name": "Fail a sandbox case's order.", "description": {}, "url": { "path": [ "v1", "test", "cases", ":id", "fail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Start a sandbox visit as the clinician would when the call begins.", "request": { "name": "Start a sandbox visit as the clinician would when the call begins.", "description": {}, "url": { "path": [ "v1", "test", "visits", ":id", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Complete a sandbox visit as the clinician would at wrap-up.", "request": { "name": "Complete a sandbox visit as the clinician would at wrap-up.", "description": {}, "url": { "path": [ "v1", "test", "visits", ":id", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Mark a sandbox visit a no-show as the clinician would at wrap-up.", "request": { "name": "Mark a sandbox visit a no-show as the clinician would at wrap-up.", "description": {}, "url": { "path": [ "v1", "test", "visits", ":id", "no_show" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Emit an event of a chosen type so a receiver can be proved.", "request": { "name": "Emit an event of a chosen type so a receiver can be proved.", "description": {}, "url": { "path": [ "v1", "test", "webhooks", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"event_type\": \"\",\n \"endpoint\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Set how long the sandbox waits before it approves a case and ships an order.", "request": { "name": "Set how long the sandbox waits before it approves a case and ships an order.", "description": {}, "url": { "path": [ "v1", "test", "autopilot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"approve_after_s\": \"\",\n \"ship_after_s\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Wipe this integration's sandbox.", "request": { "name": "Wipe this integration's sandbox.", "description": {}, "url": { "path": [ "v1", "test", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "The organization to act for, required when the credential is granted to more than one.", "key": "Cuvo-Organization", "value": "" }, { "disabled": false, "description": "(Required) 16 to 128 printable ASCII characters. Retries with the same key replay.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.cuvo.co", "key": "baseUrl" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "name": "Cuvo Integrations API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The public consult platform. A partner creates patients, records consents, files cases for a licensed clinician to decide, and follows prescriptions and orders through events and webhooks. Test mode runs the whole loop against a sandbox.", "type": "text/plain" } } }