{ "item": [ { "name": "Courier SSO", "description": "Mint a one-time Courier portal SSO URL with the same Bearer token used for the rest of the API.", "item": [ { "id": "cc7b4f21-9da7-4a64-aca0-1849fd76f52c", "name": "Creates a Courier portal SSO URL", "request": { "name": "Creates a Courier portal SSO URL", "description": { "content": "Mints a one-time SSO token for the authenticated partner and returns a URL\nto open Courier (`/sso/`). Opening that URL establishes a portal session.\n\nSend the same `Authorization: Bearer ` used for the rest of the API.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "auth", "sso" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7f6f0cc7-b731-451e-bb8b-aa299651b9dd", "name": "SSO URL created", "originalRequest": { "url": { "path": [ "api", "v2", "auth", "sso" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c9a1a9-50e3-4f05-aebd-d138ac580888", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "auth", "sso" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51e58af6-f6b8-41a8-8f9a-f730407a6ea4", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "auth", "sso" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dae03112-581c-426a-b80c-87db65ce8d7c", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "auth", "sso" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44af105c-3262-433c-a462-aff6da8da21c", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "auth", "sso" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Webhooks", "description": "Outbound HTTP POST notifications sent to your api_credentials.webhook_url when visit or notification status changes. Configure api_credentials on your LawFirm, Practice, CoordinationGroup, Insurance, Employer, or NurseCaseManagementGroup.", "item": [] }, { "name": "Order Documents", "description": "Retrieve radiology report PDFs, DICOM imaging, and invoices for orders visible to the authenticated group.", "item": [ { "id": "7091b5ac-029c-4d7e-89a1-33b299e2d427", "name": "Returns report and DICOM for an order", "request": { "name": "Returns report and DICOM for an order", "description": { "content": "Returns base64-encoded radiology report PDF and DICOM imaging data for a single order\nvisible to the authenticated user's group.\n\nProvide **one** lookup method:\n\n- `order_id` — order UUID\n- `reference_id` — accession / reference ID on the order\n- `patient_name` + `date_of_birth` + `study_description` — patient and study description\n (study description is resolved via the Translation table, same as inbound image matching)\n\n`report` and `dicom` are omitted (null) when not available for the order.\nDICOM is returned as a base64-encoded zip when fetched live from Ambra storage.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "order_documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b11f757b-d2f1-4dcd-993a-1134191076c1", "name": "order documents", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order_id\": \"\",\n \"reference_id\": \"\",\n \"report\": {\n \"data\": \"\",\n \"content_type\": \"\",\n \"filename\": \"\"\n },\n \"dicom\": {\n \"data\": \"\",\n \"content_type\": \"\",\n \"filename\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a6f83b-ca5e-4e2d-b510-598be95fb776", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be6e501-f72d-4972-b405-bc41cd96b87f", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c044614a-ad13-4459-bed1-564e48d03f7c", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08471d3a-d546-4e3c-afb2-1b87c0151192", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03bee707-8322-465f-9864-e00c3de24b1f", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b088cde-9a6b-4482-8351-92b29d813b60", "name": "Returns the radiology report PDF for an order", "request": { "name": "Returns the radiology report PDF for an order", "description": { "content": "Returns the base64-encoded radiology report PDF for a single order.\nUses the same lookup parameters as `GET /api/v2/order_documents`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "order_documents", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2613a906-f5db-4054-a878-9cbf902de44b", "name": "report", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order_id\": \"\",\n \"reference_id\": \"\",\n \"report\": {\n \"data\": \"\",\n \"content_type\": \"\",\n \"filename\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b64454b-afc2-402d-ad64-fac44a18256b", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5ebc5d8-bcbd-44bf-9a82-18beea2e0ff6", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ee7b5c3-cf91-4fed-a042-658766c50d00", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75d24097-f3eb-47a6-9868-b06d91835338", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f76b00b-c46f-401f-b6ac-b0d8b538a144", "name": "Returns DICOM imaging data for an order", "request": { "name": "Returns DICOM imaging data for an order", "description": { "content": "Returns base64-encoded DICOM data for a single order. When no local `dicom_file` is\nattached, the study is downloaded live from Ambra storage (zip bundle).\nUses the same lookup parameters as `GET /api/v2/order_documents`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "order_documents", "dicom" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7c63db0-2e13-440c-a5e8-313f981a0ec2", "name": "dicom", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "dicom" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order_id\": \"\",\n \"reference_id\": \"\",\n \"dicom\": {\n \"data\": \"\",\n \"content_type\": \"\",\n \"filename\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c862d9e-5848-4d66-89c0-feee108e471f", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "dicom" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd74d7f-c8bc-4a4e-a5ec-231066092d33", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "dicom" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64498bca-1e9c-4da4-804e-4bf8d38e4a90", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "dicom" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adfd84d5-4ba0-4dba-8d3e-589abe1fb045", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "dicom" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f82f905-829d-4764-9bbf-eaeb56728ee4", "name": "Returns the invoice PDF for an order", "request": { "name": "Returns the invoice PDF for an order", "description": { "content": "Returns the base64-encoded invoice PDF for a single order (from the parent appointment).\nUses the same lookup parameters as `GET /api/v2/order_documents`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "order_documents", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "984fbd8b-b001-4455-82cb-ae0baf986824", "name": "invoice", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order_id\": \"\",\n \"reference_id\": \"\",\n \"invoice\": {\n \"data\": \"\",\n \"content_type\": \"\",\n \"filename\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62d39825-837d-4e82-9497-5ff20700a0e9", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd2e0a7c-0127-4efb-95cc-45f3fd2d36fc", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e796c08-00c0-4e54-bcf4-bee125597d27", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "297c2c1b-398b-408f-aa04-7214394b4427", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "order_documents", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Order UUID (one lookup method required)", "type": "text/plain" }, "key": "order_id", "value": "" }, { "disabled": false, "description": { "content": "Order accession / reference ID (one lookup method required)", "type": "text/plain" }, "key": "reference_id", "value": "" }, { "disabled": false, "description": { "content": "Patient full name — use with date_of_birth and study_description", "type": "text/plain" }, "key": "patient_name", "value": "" }, { "disabled": false, "description": { "content": "Patient date of birth (YYYY-MM-DD) — use with patient_name and study_description", "type": "text/plain" }, "key": "date_of_birth", "value": "" }, { "disabled": false, "description": { "content": "Ambra study description matched via Translation table — use with patient_name and date_of_birth", "type": "text/plain" }, "key": "study_description", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Locations", "description": "Rank nearby imaging centers for a referral after medical safety answers are on file. Partners submit a preferred center; Scan books the visit.", "item": [ { "id": "fce89eec-c874-4607-8279-11ce358d4080", "name": "Returns nearby imaging centers", "request": { "name": "Returns nearby imaging centers", "description": { "content": "Ranks imaging centers near the patient for a referral. Call after\nmedical safety answers are submitted. Does not return appointment\ntimeslots; submit a preferred center with POST scheduling_preferences.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "613f1e5c-17af-42aa-9303-d3f8ae430e36", "name": "ranked imaging centers", "originalRequest": { "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"locations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"distance\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"distance\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c1a95e0-981e-4274-88d8-b8d166e79c4a", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "818a7c0c-74dd-4cd9-8723-cca9c44d6f0e", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6751bfad-da0c-4d4f-9c9c-e4a069b1153b", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e5a6ef1-b491-4ba2-a195-4aaee7a7cac5", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e096d013-10cd-45bc-a8cf-e42e4f479802", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9e2d114-b8b6-488b-aaf4-e455c539dbcb", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "key": "referral_id", "value": "" }, { "disabled": false, "description": { "content": "Search origin. Defaults to the patient's address.", "type": "text/plain" }, "key": "address", "value": "" }, { "disabled": false, "description": { "content": "Search radius in miles (default 60)", "type": "text/plain" }, "key": "radius", "value": "" }, { "disabled": false, "description": { "content": "Visit to rank for. Defaults to the first visit on the referral.", "type": "text/plain" }, "key": "visit_id", "value": "" }, { "disabled": false, "description": { "content": "Maximum centers to return (default 10)", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Testing", "description": "Staging-only fixture bootstrap, status advancement, and test webhooks.", "item": [ { "id": "ea1b4782-0e05-4213-8cab-5f427150a06f", "name": "Bootstrap sandbox fixtures", "request": { "name": "Bootstrap sandbox fixtures", "description": {}, "url": { "path": [ "api", "v2", "testing", "fixtures" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bf73c979-c3a5-464e-87b2-85c099fdd5df", "name": "Known-good sandbox identifiers for this group", "originalRequest": { "url": { "path": [ "api", "v2", "testing", "fixtures" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e69f2b5-1397-44e1-899f-e09c06444fa1", "name": "Advance a sandbox fixture visit to a chosen status", "request": { "name": "Advance a sandbox fixture visit to a chosen status", "description": {}, "url": { "path": [ "api", "v2", "testing", "visits", ":visit_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "visit_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "78d8745e-301b-436e-af17-0ff079155945", "name": "Visit advanced", "originalRequest": { "url": { "path": [ "api", "v2", "testing", "visits", ":visit_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c125468-35ed-4980-b78c-7de39b45d4fe", "name": "Fire a signed test webhook", "request": { "name": "Fire a signed test webhook", "description": {}, "url": { "path": [ "api", "v2", "testing", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_name\": \"notification.status_changed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2fb17639-a158-4459-b1ef-ffc7116cd2c4", "name": "Test event accepted", "originalRequest": { "url": { "path": [ "api", "v2", "testing", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_name\": \"notification.status_changed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "FHIR", "description": "Opt-in FHIR R4 read shapes for DiagnosticReport and ImagingStudy. Not a FHIR server.", "item": [ { "id": "18b9f03c-c908-42bd-8591-f93a0f98d77c", "name": "Read a FHIR R4 DiagnosticReport", "request": { "name": "Read a FHIR R4 DiagnosticReport", "description": {}, "url": { "path": [ "api", "v2", "fhir", "diagnostic_reports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "547b1408-2834-4794-9418-99b6abaed432", "name": "DiagnosticReport", "originalRequest": { "url": { "path": [ "api", "v2", "fhir", "diagnostic_reports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b20d05b4-6238-4744-86ce-c614bb0861b6", "name": "Read a FHIR R4 ImagingStudy", "request": { "name": "Read a FHIR R4 ImagingStudy", "description": {}, "url": { "path": [ "api", "v2", "fhir", "imaging_studies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4e8361f6-27a6-43fa-aa65-d77f166e55db", "name": "ImagingStudy", "originalRequest": { "url": { "path": [ "api", "v2", "fhir", "imaging_studies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Body Parts", "description": "", "item": [ { "id": "72de5809-27c5-402d-b919-71e0321070a1", "name": "Returns a list of body parts", "request": { "name": "Returns a list of body parts", "description": { "content": "Returns a list of body parts that can be scanned.\n\nDifferent modalities support different body parts. Call without parameters to retrieve all supported body parts, \nor include the modality parameter to filter results to body parts available for a specific scan type.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "body_parts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by modality (name or ID)", "type": "text/plain" }, "key": "modality", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a5310a73-6903-4d3d-bc37-8ba1e8568df4", "name": "body parts list", "originalRequest": { "url": { "path": [ "api", "v2", "body_parts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by modality (name or ID)", "type": "text/plain" }, "key": "modality", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"laterality\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"laterality\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c75274c2-2e66-4dc8-8007-95062928a6d6", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "body_parts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by modality (name or ID)", "type": "text/plain" }, "key": "modality", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa74684-1cd3-42f0-bc51-715059899334", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "body_parts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by modality (name or ID)", "type": "text/plain" }, "key": "modality", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92c7109b-5843-4029-95a1-ba95ca062e9b", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "body_parts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by modality (name or ID)", "type": "text/plain" }, "key": "modality", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "CPT Codes", "description": "", "item": [ { "id": "629cf219-3f85-4167-9b2d-747e5e2ddd7e", "name": "Returns CPT code mappings", "request": { "name": "Returns CPT code mappings", "description": { "content": "Returns every procedure mapping for an exact CPT code. A code can have\nmultiple mappings when modality, body part, contrast, laterality,\nmodifier, or number of views differs.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cpt_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Exact CPT code", "type": "text/plain" }, "key": "code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "df55e277-c33b-42c7-aee2-a57843174bc5", "name": "CPT code mappings", "originalRequest": { "url": { "path": [ "api", "v2", "cpt_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Exact CPT code", "type": "text/plain" }, "key": "code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"code\": \"\",\n \"modality_id\": \"\",\n \"modality_name\": \"\",\n \"body_part_id\": \"\",\n \"body_part_name\": \"\",\n \"contrast\": \"with_contrast\",\n \"laterality\": \"not_present\",\n \"modifier_id\": \"\",\n \"modifier_name\": \"\",\n \"number_of_views\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"modality_id\": \"\",\n \"modality_name\": \"\",\n \"body_part_id\": \"\",\n \"body_part_name\": \"\",\n \"contrast\": \"without_contrast\",\n \"laterality\": \"right\",\n \"modifier_id\": \"\",\n \"modifier_name\": \"\",\n \"number_of_views\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77593383-fd0f-4546-8a75-801389a9f801", "name": "code parameter missing", "originalRequest": { "url": { "path": [ "api", "v2", "cpt_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Exact CPT code", "type": "text/plain" }, "key": "code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75127853-bfab-4f3c-a87f-0d66625e86eb", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "cpt_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Exact CPT code", "type": "text/plain" }, "key": "code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41e8bc44-24c5-4432-84eb-1bb527d5e104", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "cpt_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Exact CPT code", "type": "text/plain" }, "key": "code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c66768a1-8bd0-4d44-b3ff-02be31d059be", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "cpt_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Exact CPT code", "type": "text/plain" }, "key": "code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "ICD-10 Codes", "description": "", "item": [ { "id": "c6ed31eb-3fb7-451c-bbd6-5db77fa08373", "name": "Returns a list of ICD-10 codes", "request": { "name": "Returns a list of ICD-10 codes", "description": { "content": "Returns a paginated list of ICD-10 diagnosis codes. Use q to search by code or short description, \nand ids to include selected codes in the response.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "icd10_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term matched against ICD-10 code or short description", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "ICD-10 code IDs to include and prioritize in the response", "type": "text/plain" }, "key": "ids", "value": "" }, { "disabled": false, "description": { "content": "ICD-10 code IDs to include and prioritize in the response", "type": "text/plain" }, "key": "ids", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of ICD-10 codes per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0b3787a1-3296-4b33-aaaf-42d98b9e30f1", "name": "ICD-10 codes list", "originalRequest": { "url": { "path": [ "api", "v2", "icd10_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term matched against ICD-10 code or short description", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "ICD-10 code IDs to include and prioritize in the response", "type": "text/plain" }, "key": "ids", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of ICD-10 codes per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e6b6ba4-ded1-4e1a-be42-abc7371166d6", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "icd10_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term matched against ICD-10 code or short description", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "ICD-10 code IDs to include and prioritize in the response", "type": "text/plain" }, "key": "ids", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of ICD-10 codes per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "876d3910-f196-4bcd-b2bb-e663c91d33c4", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "icd10_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term matched against ICD-10 code or short description", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "ICD-10 code IDs to include and prioritize in the response", "type": "text/plain" }, "key": "ids", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of ICD-10 codes per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7484faec-4225-4f4b-bcfe-a6a02114a53a", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "icd10_codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term matched against ICD-10 code or short description", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "ICD-10 code IDs to include and prioritize in the response", "type": "text/plain" }, "key": "ids", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of ICD-10 codes per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Law Firms", "description": "", "item": [ { "id": "98e872b9-1cca-4a2c-8535-7b778fc326c9", "name": "Creates a law firm", "request": { "name": "Creates a law firm", "description": { "content": "Creates a pending law firm request associated with the authenticated user.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"law_firm\": {\n \"name\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c0bca422-84b2-46fa-9d45-fcf57ef1be68", "name": "law firm created", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"law_firm\": {\n \"name\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"address_line_2\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "963a7920-f535-4a22-815b-74d867168fb2", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"law_firm\": {\n \"name\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d80e60b3-d07e-41cb-b2ee-f1b83ebd37f5", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"law_firm\": {\n \"name\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9303cbcc-7d6e-40a1-a6d4-66ee1b07693e", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"law_firm\": {\n \"name\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff164836-98ea-4040-b415-1e4ec44cc4cc", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"law_firm\": {\n \"name\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71dced2f-cb61-4b5e-9a27-e8a61fd3d322", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"law_firm\": {\n \"name\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96bb03c3-f10d-4435-aa07-c3de8a1e099a", "name": "Returns a list of law firms", "request": { "name": "Returns a list of law firms", "description": { "content": "Returns a paginated list of law firms matching the required search query.\nThe query is matched against law firm name and associated user contact fields.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against law firm name and associated user contact fields", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of law firms per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1c86774b-c20a-410f-8d1e-e0a849c80987", "name": "law firms list", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against law firm name and associated user contact fields", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of law firms per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"law_firms\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"address_line_2\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"address_line_2\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "036480d8-0028-496d-ae8d-daeff023c56e", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against law firm name and associated user contact fields", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of law firms per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc5261e2-fa34-434e-9214-0e2f081f830e", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against law firm name and associated user contact fields", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of law firms per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b358c4b5-d737-42cb-b7c9-c400498f967a", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against law firm name and associated user contact fields", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of law firms per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1adefc88-0546-425f-8c87-8f8dc289a60e", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against law firm name and associated user contact fields", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of law firms per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "109c50ef-669a-4f03-94da-0410d33eda18", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "law_firms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against law firm name and associated user contact fields", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of law firms per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Modalities", "description": "", "item": [ { "id": "b2f9dde3-5dfc-4a59-bd8a-aacb6a9ed890", "name": "Returns a list of modalities", "request": { "name": "Returns a list of modalities", "description": { "content": "Returns a list of modalities that are supported by the platform.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "modalities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f82907c8-1bf5-4b0f-a76c-b29be8f67774", "name": "modalities list", "originalRequest": { "url": { "path": [ "api", "v2", "modalities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "626c6a66-39c9-4594-9a66-91ecef034135", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "modalities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae7d429d-42c6-4875-952c-217da981f933", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "modalities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ade06f7-2809-4c69-9b82-9000c2035613", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "modalities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Patients", "description": "", "item": [ { "id": "b65e582a-b45e-4417-a9e7-cfd8b2d9a0e6", "name": "Creates a patient", "request": { "name": "Creates a patient", "description": { "content": "Creates a patient record for the authenticated user's group.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\"\n },\n \"middle_initial\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7006f59c-a0a0-423e-a2f2-70c0fd899a18", "name": "patient created", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\"\n },\n \"middle_initial\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"patient\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\",\n \"weight\": \"\",\n \"height_feet\": \"\",\n \"height_inches\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c7dba2-7442-4f34-b7a1-da08a246a461", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\"\n },\n \"middle_initial\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70668b00-5709-4334-b52a-697fda7792ec", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\"\n },\n \"middle_initial\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b1d80bc-e732-4a0a-8e68-e8c127997a61", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\"\n },\n \"middle_initial\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "884aefec-8435-4bf3-ab10-5926a71f84dd", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\"\n },\n \"middle_initial\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61d0778a-e64f-45cd-b626-78ab6ca7f27e", "name": "Returns a list of patients", "request": { "name": "Returns a list of patients", "description": { "content": "Returns a list of patients that are associated with the user group.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of patients per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "When true, also include patients whose referral billing-company name matches the group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0ac39cd5-7aff-40f1-960d-e40b45fd1d50", "name": "patients list", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of patients per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "When true, also include patients whose referral billing-company name matches the group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"patients\": [\n {\n \"id\": \"\",\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"other\",\n \"weight\": \"\",\n \"height_feet\": \"\",\n \"height_inches\": \"\"\n },\n {\n \"id\": \"\",\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\",\n \"weight\": \"\",\n \"height_feet\": \"\",\n \"height_inches\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29d3af63-c9a7-4498-bc2b-4218ef60d9bf", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of patients per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "When true, also include patients whose referral billing-company name matches the group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2308906-1a8f-4a0a-abc3-8982e22d2a5e", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of patients per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "When true, also include patients whose referral billing-company name matches the group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "110e9fe1-f4ea-4165-b131-a4b945e8cb7b", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of patients per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "When true, also include patients whose referral billing-company name matches the group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7630718-69f8-4b26-be6f-c964a1ba3854", "name": "Returns a patient by ID", "request": { "name": "Returns a patient by ID", "description": { "content": "Returns a patient by ID.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "06f12d1b-4299-42e9-8998-a2c61447831c", "name": "patient", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"female\",\n \"weight\": \"\",\n \"height_feet\": \"\",\n \"height_inches\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c632292d-259b-402c-90b7-3396c1bedfcd", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8770310-50e2-4d82-8fb5-890f24c921f4", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2158c9f7-a6c2-45ca-9ca3-8e57d418e023", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd3c6c3a-5b66-4b1e-bcca-bb8913a05160", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b073c13-e445-4bf1-aa03-a7a2c0b1ca59", "name": "Updates a patient", "request": { "name": "Updates a patient", "description": { "content": "Updates a patient belonging to the authenticated group.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "79164892-a495-429b-82c7-cabfc147df67", "name": "patient updated", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"gender\": \"\",\n \"weight\": \"\",\n \"height_feet\": \"\",\n \"height_inches\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ccb7818-591e-434f-b70d-2ce2486ede93", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99cbf3a1-6c40-47ba-a225-c0348226c75d", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfb1d7ac-6085-4e92-9c0c-f594b21736db", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65e713f5-3801-498b-a968-7a4efa88d211", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fb05877-5bf5-4361-9e4f-359ff3fc1bc3", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "patients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Patient ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"patient\": {\n \"first_name\": \"\",\n \"middle_initial\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"patient_profile_attributes\": {\n \"date_of_birth\": \"\",\n \"gender\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Practices", "description": "", "item": [ { "id": "a8c0d2eb-2c6f-4484-b0cd-35b8bf50b8f3", "name": "Creates a practice", "request": { "name": "Creates a practice", "description": { "content": "Creates a pending referring practice request associated with the authenticated user.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"practice\": {\n \"name\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "092b3ad9-ab46-4e00-b7e5-50c841241a35", "name": "practice created", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"practice\": {\n \"name\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"address_line_2\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17415e86-3934-44e0-a9bb-d4304b14f9ca", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"practice\": {\n \"name\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5748aac6-9a97-40ec-a866-eab7c72fd274", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"practice\": {\n \"name\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2282f5-eea0-4c5a-a0b2-59ef983c3095", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"practice\": {\n \"name\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cacb9d0-d1d7-4047-9b69-ced692c3a50e", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"practice\": {\n \"name\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d4c4d7d-017e-4c45-816e-b08d3c98303c", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"practice\": {\n \"name\": \"\",\n \"state\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45388b7c-83f5-4657-b781-bf40c8ca0fda", "name": "Returns a list of practices", "request": { "name": "Returns a list of practices", "description": { "content": "Returns a paginated list of referring practices matching the required search query.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against practice name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of practices per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e9d3dcf4-ca66-499f-b528-934cef0813f0", "name": "practices list", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against practice name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of practices per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"practices\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"address_line_2\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"address_line_2\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa2fb5e0-099f-469f-a794-a2672bc11652", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against practice name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of practices per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bdb9465-649f-47ac-90d9-82c95337cda9", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against practice name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of practices per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "292f7125-b4ba-4de7-a3f5-5980c38799d6", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against practice name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of practices per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bba9b73-3d50-42db-911d-7f50793e616d", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against practice name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of practices per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4603ba64-3486-4f50-af38-23e3bbb739d3", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "practices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term matched against practice name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of practices per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "797f99a8-0d52-40f1-8fbe-443dde92631e", "name": "Returns users for a practice", "request": { "name": "Returns users for a practice", "description": { "content": "Returns a paginated list of users belonging to the given practice, ordered by full name.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of users per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "practice_id", "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "691fb69b-4778-4129-b44c-3974bdcd6cef", "name": "users list", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of users per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\"\n },\n {\n \"id\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "496f5963-8897-41c4-9400-aaadad0c8054", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of users per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "478cb81d-4f22-4c14-a49c-59ce37129965", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of users per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd3b3c6d-d3ac-4654-82e9-987c2bade231", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of users per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28bcd1dc-3323-4f76-a109-c7e0fa5a729a", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of users per page", "type": "text/plain" }, "key": "per_page", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b25a939b-1118-4e0a-8095-2eac08244d5a", "name": "Creates a user on a practice", "request": { "name": "Creates a user on a practice", "description": { "content": "Creates a user associated with the given practice. When `role_attributes` is omitted,\nthe role defaults to `provider`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "practice_id", "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b178fc93-5df2-41c2-8e21-1c97e380b2f0", "name": "user created", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user\": {\n \"id\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "242624ca-abfc-4474-a62d-63da79610879", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae025fda-ebf4-43a9-b114-9511eb3c9b01", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a30121e0-a064-4555-9f6e-4e07b73225ad", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c53e1838-da21-44e4-871a-7621b7701cdc", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9567ee9d-5d23-4819-9147-50b8a543a034", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "practices", ":practice_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice ID", "type": "text/plain" }, "type": "any", "value": "", "key": "practice_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"full_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"npi\": \"\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Referral Orders", "description": "", "item": [ { "id": "3a36b4a6-b8b3-43e4-8890-26f5c64e1810", "name": "Submits an order form referral", "request": { "name": "Submits an order form referral", "description": { "content": "Creates a referral from an uploaded order form, sent as a base64 data URL.\n\nUse this endpoint when you have the order document but have not broken it\ndown into visits and orders yourself. Scan reads the document after submit\nand extracts the procedures from it, so the visits on the referral are\npopulated asynchronously rather than in this response. Poll\n`GET /api/v2/referrals/{id}` or subscribe to the status webhook to see them.\n\nIf you already have the modality, body part, and contrast structured, use\n`POST /api/v2/referrals` instead.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referral_orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral_order\": {\n \"order_form\": \"\",\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"preferred_location\": \"\",\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"male\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aa0a56ce-b132-4c90-a041-34af152ed909", "name": "referral order submitted", "originalRequest": { "url": { "path": [ "api", "v2", "referral_orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral_order\": {\n \"order_form\": \"\",\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"preferred_location\": \"\",\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"male\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"pending\",\n \"visits\": [],\n \"referring_provider\": \"\",\n \"patient\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a2ef35-0f5b-4511-8e3b-c8a06f632e1a", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referral_orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral_order\": {\n \"order_form\": \"\",\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"preferred_location\": \"\",\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"male\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cce4804a-8516-4cdc-8aef-dfbff1e83711", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "referral_orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral_order\": {\n \"order_form\": \"\",\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"preferred_location\": \"\",\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"male\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f8a718-1de6-418d-95de-a92fe141b890", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referral_orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral_order\": {\n \"order_form\": \"\",\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"preferred_location\": \"\",\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"male\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92bc8482-3f75-476f-92a2-18e58b67df08", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referral_orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral_order\": {\n \"order_form\": \"\",\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"preferred_location\": \"\",\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"male\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d1ffac-5ba5-4a29-bda3-a45f8b133295", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referral_orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral_order\": {\n \"order_form\": \"\",\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"preferred_location\": \"\",\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"male\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Referrals", "description": "", "item": [ { "id": "0524319a-a8c6-4df6-88ae-94ff0b9d4b9e", "name": "Creates a referral", "request": { "name": "Creates a referral", "description": { "content": "Creates an imaging referral for a patient, including visits and procedures.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"order_form\": \"data:application/pdf;name=order.pdf;base64,JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PgplbmRvYmoKMiAwIG9iago8PC9UeXBlL1BhZ2VzL0NvdW50IDEvS2lkc1szIDAgUl0+PgplbmRvYmoKMyAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDIgMCBSL01lZGlhQm94WzAgMCA2MTIgNzkyXT4+CmVuZG9iagp4cmVmCjAgNAowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMTUgMDAwMDAgbiAKMDAwMDAwMDA3NCAwMDAwMCBuIAowMDAwMDAwMTMzIDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSA0L1Jvb3QgMSAwIFI+PgpzdGFydHhyZWYKMjE3CiUlRU9GCg==\",\n \"payment_type\": \"pi\",\n \"injury_type\": \"other\",\n \"incident_date\": \"2026-01-15\",\n \"state_brand_abbreviation\": \"MA\",\n \"patient\": {\n \"first_name\": \"Ada\",\n \"last_name\": \"Sandbox\",\n \"phone_number\": \"5555550100\",\n \"date_of_birth\": \"1988-05-21\",\n \"zip_code\": \"02108\",\n \"gender\": \"female\"\n },\n \"visits\": [\n {\n \"orders\": [\n {\n \"cpt_code_id\": \"CPT_ID_FROM_FIXTURES\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "245122b8-0177-4137-b11c-7055d219fe2a", "name": "referral created", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"order_form\": \"data:s:4sa9,;name=Q;base64,\",\n \"injury_type\": \"slip_and_fall\",\n \"incident_date\": \"\",\n \"visits\": [\n {\n \"orders\": [\n {\n \"cpt_code_id\": false\n },\n {\n \"cpt_code_id\": 6699\n }\n ],\n \"modality_id\": \"\"\n },\n {\n \"orders\": [\n {\n \"cpt_code_id\": 6656.911959436054\n },\n {\n \"cpt_code_id\": 9799.719442213365\n }\n ],\n \"modality_id\": \"\"\n }\n ],\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"female\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"line_of_business\": \"health_plan\",\n \"payment_type\": \"outside_servicing\",\n \"incident_state\": \"\",\n \"visits\": [\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"exam_not_completed\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"complete\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n }\n ],\n \"referring_provider\": \"\",\n \"provider\": {\n \"id\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n },\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"payor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"insurance_number\": \"\",\n \"wc_number\": \"\",\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"patient\": {\n \"id\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_initial\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"gender\": \"female\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"call_notes\": [\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n },\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n }\n ],\n \"documents\": [\n {\n \"key_0\": false,\n \"key_1\": false\n },\n {\n \"key_0\": 5768.492430649734,\n \"key_1\": \"string\",\n \"key_2\": 7576.608311555821\n }\n ],\n \"answered_medical_questionnaire\": \"\",\n \"preferred_location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"scheduling_mode\": \"time_preferences\",\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"processing\",\n \"strategy\": \"closest_soonest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"booked\",\n \"error\": \"\",\n \"completed_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f2b328-0399-4edf-a8c7-09348c47e6ed", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"order_form\": \"data:s:4sa9,;name=Q;base64,\",\n \"injury_type\": \"slip_and_fall\",\n \"incident_date\": \"\",\n \"visits\": [\n {\n \"orders\": [\n {\n \"cpt_code_id\": false\n },\n {\n \"cpt_code_id\": 6699\n }\n ],\n \"modality_id\": \"\"\n },\n {\n \"orders\": [\n {\n \"cpt_code_id\": 6656.911959436054\n },\n {\n \"cpt_code_id\": 9799.719442213365\n }\n ],\n \"modality_id\": \"\"\n }\n ],\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"female\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff7c753-f9ff-44db-9a70-bb7b72327804", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"order_form\": \"data:s:4sa9,;name=Q;base64,\",\n \"injury_type\": \"slip_and_fall\",\n \"incident_date\": \"\",\n \"visits\": [\n {\n \"orders\": [\n {\n \"cpt_code_id\": false\n },\n {\n \"cpt_code_id\": 6699\n }\n ],\n \"modality_id\": \"\"\n },\n {\n \"orders\": [\n {\n \"cpt_code_id\": 6656.911959436054\n },\n {\n \"cpt_code_id\": 9799.719442213365\n }\n ],\n \"modality_id\": \"\"\n }\n ],\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"female\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df24a266-74bf-411c-940a-9a5fbf6e025c", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"order_form\": \"data:s:4sa9,;name=Q;base64,\",\n \"injury_type\": \"slip_and_fall\",\n \"incident_date\": \"\",\n \"visits\": [\n {\n \"orders\": [\n {\n \"cpt_code_id\": false\n },\n {\n \"cpt_code_id\": 6699\n }\n ],\n \"modality_id\": \"\"\n },\n {\n \"orders\": [\n {\n \"cpt_code_id\": 6656.911959436054\n },\n {\n \"cpt_code_id\": 9799.719442213365\n }\n ],\n \"modality_id\": \"\"\n }\n ],\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"female\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0307ca5-2224-43cd-84d9-c83afbc765b5", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"order_form\": \"data:s:4sa9,;name=Q;base64,\",\n \"injury_type\": \"slip_and_fall\",\n \"incident_date\": \"\",\n \"visits\": [\n {\n \"orders\": [\n {\n \"cpt_code_id\": false\n },\n {\n \"cpt_code_id\": 6699\n }\n ],\n \"modality_id\": \"\"\n },\n {\n \"orders\": [\n {\n \"cpt_code_id\": 6656.911959436054\n },\n {\n \"cpt_code_id\": 9799.719442213365\n }\n ],\n \"modality_id\": \"\"\n }\n ],\n \"payment_type\": \"pi\",\n \"order_type\": \"lien\",\n \"physician_notes\": \"\",\n \"referred_by\": \"\",\n \"state_brand_abbreviation\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"patient\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone_number\": \"\",\n \"date_of_birth\": \"\",\n \"middle_initial\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"language_preferences\": \"\",\n \"gender\": \"female\",\n \"height_feet\": \"\",\n \"height_inches\": \"\",\n \"weight\": \"\"\n },\n \"patient_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0565c4a-f2af-44dd-bb91-61dcf290be5d", "name": "Returns a list of referrals", "request": { "name": "Returns a list of referrals", "description": { "content": "Returns a list of referrals that are associated with the user group.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of referrals per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "Date of referral creation", "type": "text/plain" }, "key": "created_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by visit start time. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit start falls in the window. Unscheduled visits are excluded.", "type": "text/plain" }, "key": "date_of_service", "value": "" }, { "disabled": false, "description": { "content": "When true, also include referrals whose billing-company name matches the authenticated group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a2729325-891b-4515-b94b-53ac9e3a8bd3", "name": "referrals list", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of referrals per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "Date of referral creation", "type": "text/plain" }, "key": "created_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by visit start time. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit start falls in the window. Unscheduled visits are excluded.", "type": "text/plain" }, "key": "date_of_service", "value": "" }, { "disabled": false, "description": { "content": "When true, also include referrals whose billing-company name matches the authenticated group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"appointments\": [\n {\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"line_of_business\": \"workers_comp\",\n \"payment_type\": \"lien\",\n \"incident_state\": \"\",\n \"visits\": [\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"sent_to_rad\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"right\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"not_present\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"canceled\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n }\n ],\n \"referring_provider\": \"\",\n \"provider\": {\n \"id\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n },\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"payor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"insurance_number\": \"\",\n \"wc_number\": \"\",\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"patient\": {\n \"id\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_initial\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"gender\": \"female\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"call_notes\": [\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n },\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n }\n ],\n \"documents\": [\n {\n \"key_0\": 5378,\n \"key_1\": 6525.5943210707\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"answered_medical_questionnaire\": \"\",\n \"preferred_location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"scheduling_mode\": \"needs_other_location\",\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"processing\",\n \"strategy\": \"soonest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"no_availability\",\n \"error\": \"\",\n \"completed_at\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"line_of_business\": \"patient_direct\",\n \"payment_type\": \"cash_pay\",\n \"incident_state\": \"\",\n \"visits\": [\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"co_signed\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"right\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"co_signed\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n }\n ],\n \"referring_provider\": \"\",\n \"provider\": {\n \"id\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n },\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"payor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"insurance_number\": \"\",\n \"wc_number\": \"\",\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"patient\": {\n \"id\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_initial\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"gender\": \"other\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"call_notes\": [\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n },\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n }\n ],\n \"documents\": [\n {\n \"key_0\": 4466.855248781618,\n \"key_1\": 6634\n },\n {\n \"key_0\": 4668,\n \"key_1\": 6379.475058787682,\n \"key_2\": 4631.093539573414\n }\n ],\n \"answered_medical_questionnaire\": \"\",\n \"preferred_location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"scheduling_mode\": \"anytime_anywhere\",\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"completed\",\n \"strategy\": \"closest_soonest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"booking_failed\",\n \"error\": \"\",\n \"completed_at\": \"\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bceec18d-afb5-4df4-9fd2-ccfdebdc7c9d", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of referrals per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "Date of referral creation", "type": "text/plain" }, "key": "created_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by visit start time. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit start falls in the window. Unscheduled visits are excluded.", "type": "text/plain" }, "key": "date_of_service", "value": "" }, { "disabled": false, "description": { "content": "When true, also include referrals whose billing-company name matches the authenticated group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfcfeee7-041e-4904-901e-37aa8a96f3ab", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of referrals per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "Date of referral creation", "type": "text/plain" }, "key": "created_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by visit start time. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit start falls in the window. Unscheduled visits are excluded.", "type": "text/plain" }, "key": "date_of_service", "value": "" }, { "disabled": false, "description": { "content": "When true, also include referrals whose billing-company name matches the authenticated group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "750374eb-097a-4ea6-9bb3-142566f91197", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of referrals per page", "type": "text/plain" }, "key": "per_page", "value": "" }, { "disabled": false, "description": { "content": "Date of referral creation", "type": "text/plain" }, "key": "created_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by visit start time. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit start falls in the window. Unscheduled visits are excluded.", "type": "text/plain" }, "key": "date_of_service", "value": "" }, { "disabled": false, "description": { "content": "When true, also include referrals whose billing-company name matches the authenticated group", "type": "text/plain" }, "key": "billable", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bd87a28-77e1-4308-9e11-53f22101aae9", "name": "Returns a referral by ID", "request": { "name": "Returns a referral by ID", "description": { "content": "Returns a referral by ID.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "73d2014f-083d-4b57-9f5b-80c4c6516e98", "name": "referral", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"line_of_business\": \"health_plan\",\n \"payment_type\": \"outside_servicing\",\n \"incident_state\": \"\",\n \"visits\": [\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"exam_not_completed\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"complete\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n }\n ],\n \"referring_provider\": \"\",\n \"provider\": {\n \"id\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n },\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"payor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"insurance_number\": \"\",\n \"wc_number\": \"\",\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"patient\": {\n \"id\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_initial\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"gender\": \"female\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"call_notes\": [\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n },\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n }\n ],\n \"documents\": [\n {\n \"key_0\": false,\n \"key_1\": false\n },\n {\n \"key_0\": 5768.492430649734,\n \"key_1\": \"string\",\n \"key_2\": 7576.608311555821\n }\n ],\n \"answered_medical_questionnaire\": \"\",\n \"preferred_location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"scheduling_mode\": \"time_preferences\",\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"processing\",\n \"strategy\": \"closest_soonest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"booked\",\n \"error\": \"\",\n \"completed_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aa66a35-eba7-46e6-9a9b-4e617253cdca", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2040a520-e61b-42e9-b9f0-129018e30729", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55d06daf-ba3f-4f29-8855-3875f9901903", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff75bb29-6148-4888-8a2e-c42c4b0bee68", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fda9aea-0c49-4338-943b-348c001e3c13", "name": "Updates a referral", "request": { "name": "Updates a referral", "description": { "content": "Updates assignable ownership, ICD-10, and workers' compensation fields for a referral\nbelonging to the authenticated group.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"user_id\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"payer\": \"\",\n \"claim_number\": \"\",\n \"wcb_number\": \"\",\n \"adjuster_name\": \"\",\n \"adjuster_phone\": \"\",\n \"adjuster_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "08c7bf37-fc63-477b-bee3-cdb6b1c162f7", "name": "referral updated", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"user_id\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"payer\": \"\",\n \"claim_number\": \"\",\n \"wcb_number\": \"\",\n \"adjuster_name\": \"\",\n \"adjuster_phone\": \"\",\n \"adjuster_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"line_of_business\": \"health_plan\",\n \"payment_type\": \"outside_servicing\",\n \"incident_state\": \"\",\n \"visits\": [\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"exam_not_completed\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"complete\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n }\n ],\n \"referring_provider\": \"\",\n \"provider\": {\n \"id\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n },\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"payor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"insurance_number\": \"\",\n \"wc_number\": \"\",\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"patient\": {\n \"id\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_initial\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"gender\": \"female\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"call_notes\": [\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n },\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n }\n ],\n \"documents\": [\n {\n \"key_0\": false,\n \"key_1\": false\n },\n {\n \"key_0\": 5768.492430649734,\n \"key_1\": \"string\",\n \"key_2\": 7576.608311555821\n }\n ],\n \"answered_medical_questionnaire\": \"\",\n \"preferred_location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"scheduling_mode\": \"time_preferences\",\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"processing\",\n \"strategy\": \"closest_soonest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"booked\",\n \"error\": \"\",\n \"completed_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa16cca7-8022-4cfc-a1b0-d6a0cf55bfc5", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"user_id\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"payer\": \"\",\n \"claim_number\": \"\",\n \"wcb_number\": \"\",\n \"adjuster_name\": \"\",\n \"adjuster_phone\": \"\",\n \"adjuster_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "244da25e-261b-4bb0-b55d-23c762bd0a66", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"user_id\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"payer\": \"\",\n \"claim_number\": \"\",\n \"wcb_number\": \"\",\n \"adjuster_name\": \"\",\n \"adjuster_phone\": \"\",\n \"adjuster_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "159c7b75-045a-451d-b13c-fcd8f58859c3", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"user_id\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"payer\": \"\",\n \"claim_number\": \"\",\n \"wcb_number\": \"\",\n \"adjuster_name\": \"\",\n \"adjuster_phone\": \"\",\n \"adjuster_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad884c5e-5dfd-4fee-84e7-f90c8980eef9", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"user_id\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"payer\": \"\",\n \"claim_number\": \"\",\n \"wcb_number\": \"\",\n \"adjuster_name\": \"\",\n \"adjuster_phone\": \"\",\n \"adjuster_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b4961aa-5017-40cd-ac3f-39a62fb8ccce", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"practice_id\": \"\",\n \"law_firm_id\": \"\",\n \"coordination_group_id\": \"\",\n \"user_id\": \"\",\n \"icd10_codes\": [\n \"\",\n \"\"\n ],\n \"payer\": \"\",\n \"claim_number\": \"\",\n \"wcb_number\": \"\",\n \"adjuster_name\": \"\",\n \"adjuster_phone\": \"\",\n \"adjuster_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8dce874c-f1dd-4c3b-99e7-0b363b315fe7", "name": "Cancels a referral", "request": { "name": "Cancels a referral", "description": { "content": "Cancels a referral belonging to the authenticated group.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "21e27a0f-b849-4c0b-85e4-2cdbd8364a4a", "name": "referral canceled", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa58a17a-3171-416f-afaf-a7f5928eeaca", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e04c07d-1f78-48ab-bc6c-0c612b5ef445", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b3c2e0e-fa35-4a5c-99db-1bc49551c140", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ac1595e-4798-4b8c-8975-792a154ce878", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "077aaa52-2ab2-4ea3-999c-79f020750f7c", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"referral\": {\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0508bf47-097b-4b7c-9d3e-aed96c4c78c2", "name": "Creates an order on a visit", "request": { "name": "Creates an order on a visit", "description": { "content": "Adds a procedure (order) to an existing visit on a referral.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "visit_id", "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "df9e2d1a-8cad-40d1-9473-576f4f8368d7", "name": "order created", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order\": {\n \"id\": \"\",\n \"visit_id\": \"\",\n \"body_part_id\": \"\",\n \"contrast\": \"with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f9b68be-db25-467d-9f58-aee8b618079e", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de3e8704-ff93-4175-ab54-205dd9e77c8e", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4393ced4-1604-4ea7-af5d-ae2e04bedf2b", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb25a76-1c04-4c82-8982-31ea8074cc45", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe310ca-ab1c-4a0d-a507-22e46f0f5374", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b19c9276-ed2e-4571-92be-c684315cde25", "name": "Updates an order on a visit", "request": { "name": "Updates an order on a visit", "description": { "content": "Updates procedure fields on an order.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "visit_id", "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ee986ec-66ad-4022-8c0a-9663b06df84a", "name": "order updated", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"order\": {\n \"id\": \"\",\n \"visit_id\": \"\",\n \"body_part_id\": \"\",\n \"contrast\": \"with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65fc3437-2b3f-4a28-a17e-fe8863dd8185", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aea251a7-ac0b-451b-8e76-032f9efc952f", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31183eb2-28a9-4cae-97da-660e9dc0fcb6", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88fe4b1c-20af-485f-a61b-3832257caabe", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bf616b5-3d62-41db-b758-3f66ef66b80a", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"body_part_id\": \"\",\n \"contrast\": \"without_and_with_contrast\",\n \"laterality\": \"not_present\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2051c15-9efa-4c88-b3fc-6252a5c663e4", "name": "Deletes an order on a visit", "request": { "name": "Deletes an order on a visit", "description": { "content": "Soft-deletes an order from a visit.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "visit_id", "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ae572733-202d-4561-8c14-e0b74c4d9a3d", "name": "order deleted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f7ecdcf-70e3-40ee-af9c-5ae042190ba6", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4bad240-cc3c-407b-9c99-d884e9749354", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5475e1b-04ea-4e71-9c48-4f1fd5048320", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1ced8fb-b187-480a-adb6-84bb49197105", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "visits", ":visit_id", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" }, { "disabled": false, "description": { "content": "(Required) Visit ID", "type": "text/plain" }, "type": "any", "value": "", "key": "visit_id" }, { "disabled": false, "description": { "content": "(Required) Order ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67b97118-d017-445f-bd58-7b8e59ac38c6", "name": "Lists referral notification delivery history", "request": { "name": "Lists referral notification delivery history", "description": { "content": "Returns newest-first email and SMS delivery metadata attached to the referral\nor one of its visits. Recipient details, subjects, message bodies, email HTML,\nprovider identifiers, and failure text are never returned.\n\nThis capability is disabled until Scan enables notification read access for\nyour account.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8c4dbafa-4731-4a1f-beeb-8c6b60fc11dc", "name": "Referral notification delivery metadata", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"referral_notifications\": [\n {\n \"id\": \"\",\n \"channel\": \"email\",\n \"notification_type\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"visit_id\": \"\"\n },\n {\n \"id\": \"\",\n \"channel\": \"sms\",\n \"notification_type\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"visit_id\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5ba9131-c50d-42a4-9615-23d666b41e55", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "418b8996-660c-476e-9907-1a0500622cb7", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ae7c8a4-9fb4-43d8-aa95-ea638f5b82c9", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f8be94e-b10b-4f7d-a078-b3b7cfdbcb87", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3741cd7-06c6-408f-a31b-cf9297b8774f", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e8c2a11-7f4d-4c9b-9a1e-b0d3f6e8c4a1", "name": "Lists referral payments", "request": { "name": "Lists referral payments", "description": { "content": "Returns newest-first payments logged against the referral, including\namount, payment date, check number, and any procedures the payment is\nallocated to. Procedure `description` matches the portal study string\n(for example `MRI Left Ankle w/contrast`).\n\nThis capability is disabled until Scan enables payment read access for\nyour account.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a91c4d20-6b3e-4f17-8d52-c7e1a90f2b33", "name": "Referral payments", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"referral_payments\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"date\": \"\",\n \"check_number\": \"\",\n \"procedures\": [\n {\n \"order_id\": \"\",\n \"accession_id\": \"\",\n \"cpt_code\": \"\",\n \"description\": \"MRI Left Ankle w/contrast\"\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b02d5e31-7c4f-4028-9e63-d8f2ba103c44", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13e6f42-8d50-4139-af74-e9a3cb214d55", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d24f7053-9e61-424a-b085-fab4dc325e66", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3508164-af72-435b-c196-0bc5ed436f77", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4619275-b083-446c-d2a7-1cd6fe547088", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ecf061bb-d097-4000-a260-fd59b8ad628e", "name": "Returns medical safety questions", "request": { "name": "Returns medical safety questions", "description": { "content": "Returns the medical safety questionnaire for a referral, including any\nanswers already stored. Submit answers before listing nearby centers so\nranking can apply open-scanner and weight filters.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "68de020d-97cc-45ca-a03d-3e17fc945421", "name": "medical safety questions", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"questions\": [\n {\n \"id\": \"\",\n \"key\": \"\",\n \"label\": \"\",\n \"question_type\": \"\",\n \"blocking\": \"\",\n \"follow_up\": \"\",\n \"answer\": \"\",\n \"additional_detail\": \"\"\n },\n {\n \"id\": \"\",\n \"key\": \"\",\n \"label\": \"\",\n \"question_type\": \"\",\n \"blocking\": \"\",\n \"follow_up\": \"\",\n \"answer\": \"\",\n \"additional_detail\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2263c8db-b04e-4125-820d-29e04b76c1c5", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dca49af6-32e2-4649-9151-a539d064c48a", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa965c1b-e77a-4309-91fb-0590f5fd6d44", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f6acfd4-77ea-4068-a0ab-6c6d7f37614b", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc2e8186-cba9-404c-a6ee-e1d58fb27c7f", "name": "Submits medical safety answers", "request": { "name": "Submits medical safety answers", "description": { "content": "Stores medical safety answers on the referral. Use the question `id`\nvalues from GET. Answers of yes on blocking questions (for example metal\nimplants) can prevent live booking at some centers.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"medical_questionnaire\": [\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n },\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "31707bac-a0df-4ae3-9b99-abdf9bf2d289", "name": "answers stored", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"medical_questionnaire\": [\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n },\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e77075b-4462-49a7-ac6e-9edb64f1cf48", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"medical_questionnaire\": [\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n },\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84b4185f-1c9a-4d02-8373-95b429d7e20a", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"medical_questionnaire\": [\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n },\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c3135e-2568-46fd-aab0-d0609368c7b1", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"medical_questionnaire\": [\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n },\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c17f53f7-042d-412b-8afb-fb3e1c8b16ec", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"medical_questionnaire\": [\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n },\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cf29dc6-2c97-4c53-ad34-ed3b75fe15fb", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "medical_questionnaire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"medical_questionnaire\": [\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n },\n {\n \"id\": \"\",\n \"answer\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d399fa04-2ffe-43a3-8a6c-ad8d048d8672", "name": "Requests automatic booking", "request": { "name": "Requests automatic booking", "description": { "content": "Asynchronously ranks eligible centers and books the best live opening.\nPartners do not select a timeslot. The response confirms that the\nrequest was accepted; it does not mean the visit is booked.\n\nThis capability is off until Scan enables it for your account.\n\nThis is the only endpoint that requires your API credential to have an\nacting user assigned, because the resulting booking is attributed to a\nperson. Requests from a credential without one return `422`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c1c5a8d8-2054-41a7-8d5a-29528428ae12", "name": "auto-book request accepted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"completed\",\n \"strategy\": \"closest_soonest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"contacted_for_booking\",\n \"error\": \"\",\n \"completed_at\": \"\"\n },\n \"referral\": {\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"line_of_business\": \"personal_injury\",\n \"payment_type\": \"pip\",\n \"incident_state\": \"\",\n \"visits\": [\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"right\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"not_present\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"pending_auth\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"not_present\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"right\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"complete\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n }\n ],\n \"referring_provider\": \"\",\n \"provider\": {\n \"id\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n },\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"payor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"insurance_number\": \"\",\n \"wc_number\": \"\",\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"patient\": {\n \"id\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_initial\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"gender\": \"female\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"call_notes\": [\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n },\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n }\n ],\n \"documents\": [\n {\n \"key_0\": 2908.393911428531,\n \"key_1\": true\n },\n {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 3459,\n \"key_3\": 1059.041648594412\n }\n ],\n \"answered_medical_questionnaire\": \"\",\n \"preferred_location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"scheduling_mode\": \"time_preferences\",\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"processing\",\n \"strategy\": \"closest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"no_availability\",\n \"error\": \"\",\n \"completed_at\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2191e8c3-a726-4c7a-b519-37d81fa54706", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec0034b7-5c57-44b1-ba66-927068872c9a", "name": "Endpoint is not enabled for this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efbf3cb4-dfef-4a23-8815-2f8764f489bc", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e68ca1d-abb7-4aff-9312-37c0de1f738f", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f1b2678-d9dc-46d3-ba8b-95461926b91d", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcd1bb9c-7a91-4d16-ba99-6877c3e939cf", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Existing referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"book\": {\n \"strategy\": \"closest_soonest\",\n \"radius\": 200,\n \"address\": \"\",\n \"webhook_url\": \"https://\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3145a6f-de43-44b8-8d71-8628c85e4fb4", "name": "Submits preferred center and availability", "request": { "name": "Submits preferred center and availability", "description": { "content": "Records how the patient prefers to be scheduled. Scan books the visit\nfrom this preference. `anytime_anywhere` needs no center.\n`time_preferences` requires a `location_id` from GET /api/v2/locations\nand either `preferred_times` or `asap: true`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "referrals", ":referral_id", "scheduling_preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "referral_id", "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduling_preference\": {\n \"mode\": \"time_preferences\",\n \"location_id\": \"\",\n \"asap\": \"\",\n \"preferred_times\": [\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n },\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n }\n ],\n \"center_name\": \"\",\n \"center_address\": \"\",\n \"start_time\": \"\",\n \"phone_number\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "50826a46-44f3-4586-a3cf-f4075a320ece", "name": "preference saved", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "scheduling_preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduling_preference\": {\n \"mode\": \"time_preferences\",\n \"location_id\": \"\",\n \"asap\": \"\",\n \"preferred_times\": [\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n },\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n }\n ],\n \"center_name\": \"\",\n \"center_address\": \"\",\n \"start_time\": \"\",\n \"phone_number\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"line_of_business\": \"health_plan\",\n \"payment_type\": \"outside_servicing\",\n \"incident_state\": \"\",\n \"visits\": [\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"exam_not_completed\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"modality\": \"\",\n \"procedures\": [\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n },\n {\n \"body_part\": \"\",\n \"procedure\": \"\",\n \"contrast\": \"\",\n \"laterality\": \"left\",\n \"cpt_code\": \"\",\n \"cpt_code_id\": \"\",\n \"cpt_system\": \"\",\n \"accession_id\": \"\",\n \"study_uid\": \"\",\n \"series_uid\": \"\",\n \"image_link\": \"\",\n \"report_link\": \"\"\n }\n ],\n \"status\": \"complete\",\n \"start_time\": \"\",\n \"radiologist_group_name\": \"\",\n \"location\": {\n \"id\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n }\n }\n ],\n \"referring_provider\": \"\",\n \"provider\": {\n \"id\": \"\",\n \"name\": \"\",\n \"npi\": \"\"\n },\n \"law_firm\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"practice\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"payor\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"insurance_number\": \"\",\n \"wc_number\": \"\",\n \"icd10_codes\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"system\": \"\",\n \"short_description\": \"\"\n }\n ],\n \"patient\": {\n \"id\": \"\",\n \"identifier\": {\n \"system\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_initial\": \"\",\n \"date_of_birth\": \"\",\n \"date_of_birth_iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"gender\": \"female\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"call_notes\": [\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n },\n {\n \"created_at\": \"\",\n \"notes\": \"\"\n }\n ],\n \"documents\": [\n {\n \"key_0\": false,\n \"key_1\": false\n },\n {\n \"key_0\": 5768.492430649734,\n \"key_1\": \"string\",\n \"key_2\": 7576.608311555821\n }\n ],\n \"answered_medical_questionnaire\": \"\",\n \"preferred_location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"scheduling_mode\": \"time_preferences\",\n \"auto_book_request\": {\n \"id\": \"\",\n \"status\": \"processing\",\n \"strategy\": \"closest_soonest\",\n \"radius\": \"\",\n \"address\": \"\",\n \"outcome\": \"booked\",\n \"error\": \"\",\n \"completed_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8621c98-9b3b-477f-917e-fe4a94db5c92", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "scheduling_preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduling_preference\": {\n \"mode\": \"time_preferences\",\n \"location_id\": \"\",\n \"asap\": \"\",\n \"preferred_times\": [\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n },\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n }\n ],\n \"center_name\": \"\",\n \"center_address\": \"\",\n \"start_time\": \"\",\n \"phone_number\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c26602be-a071-48ef-b7d4-c1ecb97fbbd9", "name": "Resource not found or not accessible to this account", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "scheduling_preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduling_preference\": {\n \"mode\": \"time_preferences\",\n \"location_id\": \"\",\n \"asap\": \"\",\n \"preferred_times\": [\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n },\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n }\n ],\n \"center_name\": \"\",\n \"center_address\": \"\",\n \"start_time\": \"\",\n \"phone_number\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e60ca7e9-27b1-46ef-ab6b-f2bc33a22147", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "scheduling_preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduling_preference\": {\n \"mode\": \"time_preferences\",\n \"location_id\": \"\",\n \"asap\": \"\",\n \"preferred_times\": [\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n },\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n }\n ],\n \"center_name\": \"\",\n \"center_address\": \"\",\n \"start_time\": \"\",\n \"phone_number\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81115ab-3352-44a2-9d5f-65383912fa3f", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "scheduling_preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduling_preference\": {\n \"mode\": \"time_preferences\",\n \"location_id\": \"\",\n \"asap\": \"\",\n \"preferred_times\": [\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n },\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n }\n ],\n \"center_name\": \"\",\n \"center_address\": \"\",\n \"start_time\": \"\",\n \"phone_number\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f102b3ee-391e-4941-9e92-217f2f21bb9c", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "referrals", ":referral_id", "scheduling_preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Referral ID", "type": "text/plain" }, "type": "any", "value": "", "key": "referral_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduling_preference\": {\n \"mode\": \"time_preferences\",\n \"location_id\": \"\",\n \"asap\": \"\",\n \"preferred_times\": [\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n },\n {\n \"day_of_week\": \"\",\n \"time_of_day\": \"\"\n }\n ],\n \"center_name\": \"\",\n \"center_address\": \"\",\n \"start_time\": \"\",\n \"phone_number\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Status", "description": "", "item": [ { "id": "983ff097-07fe-4711-8f6a-9042ee1d24e0", "name": "Updates the status of a visit", "request": { "name": "Updates the status of a visit", "description": { "content": "Supply-side endpoint for imaging-center integrations. Updates a visit by\naccession ID. Supported statuses: `appointment_received` and `no_show`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accession_id\": \"\",\n \"status\": \"no_show\",\n \"start_time\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3edce422-0dfc-4738-9d99-2b26557c0bdd", "name": "status updated successfully", "originalRequest": { "url": { "path": [ "api", "v2", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accession_id\": \"\",\n \"status\": \"no_show\",\n \"start_time\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d333d3a8-6f03-4c54-936d-4a4fb2bbd7b6", "name": "Missing, expired, or wrong-environment token", "originalRequest": { "url": { "path": [ "api", "v2", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accession_id\": \"\",\n \"status\": \"no_show\",\n \"start_time\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614f94fb-5e75-4ee5-9265-6c3593aacc30", "name": "Request body failed validation", "originalRequest": { "url": { "path": [ "api", "v2", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accession_id\": \"\",\n \"status\": \"no_show\",\n \"start_time\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a57d5a7-5bd4-4421-bc56-3b98af4b7ba3", "name": "Sandbox request allowance exhausted", "originalRequest": { "url": { "path": [ "api", "v2", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accession_id\": \"\",\n \"status\": \"no_show\",\n \"start_time\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34e75640-4474-4186-85ed-6dc342a879ab", "name": "Unexpected internal error", "originalRequest": { "url": { "path": [ "api", "v2", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accession_id\": \"\",\n \"status\": \"no_show\",\n \"start_time\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-Id", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"documentation_url\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.staging.scan.com" }, { "key": "bearerToken", "value": "", "type": "string" } ], "info": { "_postman_id": "c8d3aaaf-6596-49d3-9495-a13d004b1974", "name": "Scan.com API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "This API provides comprehensive access to Scan.com’s core functionalities, \nincluding management of referrals, patient information, authentication, body parts, \nand imaging modalities. It enables seamless integration for scheduling, data retrieval, \nand workflow automation within the Scan.com platform, facilitating efficient and secure \nhandling of medical imaging processes.\n", "type": "text/plain" } } }