{ "item": [ { "id": "c1a761a6-f182-59c8-87df-705cc0e6c6df", "name": "Fhir", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0e8a5904-5279-5544-8f4a-02a78f9a1f9e", "name": "FHIR R4 CapabilityStatement — exactly what this gateway supports, nothing more.", "request": { "name": "FHIR R4 CapabilityStatement — exactly what this gateway supports, nothing more.", "description": { "content": "No bearer key required (this is the same discovery document for every caller); Content-Type is application/fhir+json, not the {data} envelope. Lists ONLY the resources/interactions this gateway actually serves — Patient, Appointment, DocumentReference (notes), Condition, AllergyIntolerance, MedicationStatement, MedicationRequest, Practitioner (providers), Coverage, Organization (insurance payers) and MedicationKnowledge (inventory items), search parameters limited to the query filters the plain JSON routes already accept. There is no _include/_revinclude and no general /fhir passthrough — see the developer guide (api-docs/fhir.mdx) for what a partner will not find.", "type": "text/plain" }, "url": { "path": [ "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/fhir+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d39728c8-21f9-5a94-8ebc-57e1c675cfe5", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/fhir+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/fhir+json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "03908a5f-75ce-5b7a-8252-452245180559", "name": "Me", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2ca33096-e90f-5bff-bdb4-5e72e5d7ad6b", "name": "The calling key's identity, environment and scopes.", "request": { "name": "The calling key's identity, environment and scopes.", "description": { "content": "Response is the resource DIRECTLY — no `data` wrapper (see the top-level description's \"Response envelope\" note).", "type": "text/plain" }, "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "403c950d-b17d-5230-9e20-ff244bd9260d", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_id\": \"key_01H...\",\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"environment\": \"live\",\n \"scopes\": [\n \"inventory.items:read\",\n \"inventory.availability:read\"\n ],\n \"org_id\": null,\n \"sandbox\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8677b969-86af-504b-b980-06622f6e234e", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09b37889-3548-5497-b6ec-28aff96a5a73", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e03ec072-cb7f-504f-ac95-60fc64f0768f", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "87060668-18aa-518d-8a9d-8fc09c49c37f", "name": "Connections", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a8e09c16-05ba-5d93-a774-2728480a0bee", "name": "Clinics this key can reach, and the scopes granted to it.", "request": { "name": "Clinics this key can reach, and the scopes granted to it.", "description": { "content": "For a workspace TEST key this is always one entry — the workspace's own sandbox, marked sandbox: true. For a LIVE workspace key this lists every clinic with an ACTIVE, non-expired connection that also still has API access switched on — the same set the key could actually reach on the next call, never a stale or pending one. An unverified workspace, or one with no connections yet, gets an empty list. A clinic-owned key gets exactly one entry, for its own clinic.", "type": "text/plain" }, "url": { "path": [ "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "073f1eb8-b288-5e40-bcf2-3e35bcb3508b", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"clinic_name\": \"City Medical Center\",\n \"environment\": \"live\",\n \"granted_scopes\": [\n \"inventory.items:read\"\n ],\n \"connected_at\": \"2026-09-28T10:00:00Z\",\n \"expires_at\": null,\n \"sandbox\": false\n }\n ],\n \"has_more\": false,\n \"next_cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c4cccb7-75e9-5afd-bb68-49581c50845b", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907a0a30-22f5-5019-bf89-3b694639cebf", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45b000e4-5f17-5511-82a0-1592fcc6f61f", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "be8ac7f7-0540-520c-91be-2cbbf1868fc8", "name": "Inventory", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9fdd54f5-f640-5651-95d8-5119b9641785", "name": "Stock locations inside the clinic (storerooms, shelves, fridges).", "request": { "name": "Stock locations inside the clinic (storerooms, shelves, fridges).", "description": { "content": "For a workspace TEST key this reads the workspace's seeded synthetic sandbox, never a real clinic's locations — same shape either way.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e15683cd-f4b5-5e6d-9666-5095c2dfa99a", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"6a9f7e3e-2b5a-4a86-8f0d-4a6a2b3c9a11\",\n \"name\": \"Main storeroom\",\n \"type\": \"room\",\n \"is_active\": true,\n \"updated_at\": \"2026-09-20T10:00:00Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3c031c0-33a1-5fea-9804-cf560b542f7f", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91822994-2615-57e2-be04-ea6b62aaeb62", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be0f8707-1d87-51c1-a1e9-cd45b4c98b8a", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ac10ba9-006d-5fd2-ae1f-bdd38033c797", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a62d85d-b537-5f53-9de5-a64ebf84cf77", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45a680e2-386b-58d6-ab39-52443e37dcf9", "name": "The clinic's catalogue.", "request": { "name": "The clinic's catalogue.", "description": { "content": "For a workspace TEST key this reads the workspace's seeded synthetic sandbox catalogue, never a real clinic's — same shape either way.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "culpa qui consectetur", "description": "Free-text name match. Labelled as a text match, never as equivalence." }, { "disabled": false, "key": "barcode", "value": "culpa qui consectetur" }, { "disabled": false, "key": "category", "value": "culpa qui consectetur" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aa5866e5-635e-55ee-8abc-e03266a8fa41", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "culpa qui consectetur" }, { "key": "barcode", "value": "culpa qui consectetur" }, { "key": "category", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\",\n \"name\": \"Paracetamol 500mg Tablets\",\n \"generic_name\": \"paracetamol\",\n \"brand_name\": \"Panadol\",\n \"strength\": \"500mg\",\n \"dosage_form\": \"tablet\",\n \"category\": \"analgesic\",\n \"item_type\": \"medication\",\n \"unit_of_measure\": \"tablet\",\n \"is_active\": true,\n \"identifiers\": [\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ],\n \"retail_price\": {\n \"amount\": \"12.50\",\n \"currency\": \"NGN\"\n },\n \"updated_at\": \"2026-09-20T10:00:00Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fe2b2fb-9790-5180-910f-7f13ec7124bd", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "culpa qui consectetur" }, { "key": "barcode", "value": "culpa qui consectetur" }, { "key": "category", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d58018a-07c5-5f80-9969-e7796639d92f", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "culpa qui consectetur" }, { "key": "barcode", "value": "culpa qui consectetur" }, { "key": "category", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca0de2b5-d331-5425-aa1b-ff753e242fbe", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "culpa qui consectetur" }, { "key": "barcode", "value": "culpa qui consectetur" }, { "key": "category", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de51dd09-e390-5935-8fa5-6dffaea4bbc8", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "culpa qui consectetur" }, { "key": "barcode", "value": "culpa qui consectetur" }, { "key": "category", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "479d3f9e-91b2-5a7a-963a-9275803b760b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "culpa qui consectetur" }, { "key": "barcode", "value": "culpa qui consectetur" }, { "key": "category", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdd63cd3-349b-5eb9-bd5a-94097e5376fa", "name": "Add a catalogue item.", "request": { "name": "Add a catalogue item.", "description": { "content": "Unknown fields refused by name. container_sale_price/container_cost are refused outright.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"reprehenderit ad in laborum sed\",\n \"item_type\": \"id nostrud ex culpa\",\n \"generic_name\": \"dolore sit\",\n \"brand_name\": \"aliquip Ut\",\n \"strength\": \"eu elit Excepteur\",\n \"dosage_form\": \"in aliqua ad dolor\",\n \"category\": \"dolor dolor aliqua sit deserunt\",\n \"unit_of_measure\": \"non minim nisi\",\n \"upc\": \"Ut esse\",\n \"nafdac_no\": \"consectetur ullamco sed dolore\",\n \"ndc\": \"veniam fugiat la\",\n \"default_sale_price\": -37527765.007689595,\n \"container_quantity\": -94176407.06524253,\n \"container_label\": \"velit Excepteur\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a2bf6ed-c4a8-5ce7-bae8-d781a78551d2", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"reprehenderit ad in laborum sed\",\n \"item_type\": \"id nostrud ex culpa\",\n \"generic_name\": \"dolore sit\",\n \"brand_name\": \"aliquip Ut\",\n \"strength\": \"eu elit Excepteur\",\n \"dosage_form\": \"in aliqua ad dolor\",\n \"category\": \"dolor dolor aliqua sit deserunt\",\n \"unit_of_measure\": \"non minim nisi\",\n \"upc\": \"Ut esse\",\n \"nafdac_no\": \"consectetur ullamco sed dolore\",\n \"ndc\": \"veniam fugiat la\",\n \"default_sale_price\": -37527765.007689595,\n \"container_quantity\": -94176407.06524253,\n \"container_label\": \"velit Excepteur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:4277495c-013e-fe82-f124-cf07359796d8\",\n \"name\": \"ad\",\n \"is_active\": true,\n \"identifiers\": [\n {\n \"system\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"system\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ],\n \"generic_name\": \"dolore nostrud\",\n \"brand_name\": \"ea ve\",\n \"strength\": \"pariatur laborum adipisicing\",\n \"dosage_form\": \"commodo occaecat elit mollit laborum\",\n \"category\": \"dolor sint aliqua incididunt\",\n \"item_type\": \"cillum\",\n \"unit_of_measure\": \"minim culpa\",\n \"retail_price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"updated_at\": \"2013-07-03T11:17:46.429Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2d25992-a701-5ab1-8722-fe9c3cc4fa2c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"reprehenderit ad in laborum sed\",\n \"item_type\": \"id nostrud ex culpa\",\n \"generic_name\": \"dolore sit\",\n \"brand_name\": \"aliquip Ut\",\n \"strength\": \"eu elit Excepteur\",\n \"dosage_form\": \"in aliqua ad dolor\",\n \"category\": \"dolor dolor aliqua sit deserunt\",\n \"unit_of_measure\": \"non minim nisi\",\n \"upc\": \"Ut esse\",\n \"nafdac_no\": \"consectetur ullamco sed dolore\",\n \"ndc\": \"veniam fugiat la\",\n \"default_sale_price\": -37527765.007689595,\n \"container_quantity\": -94176407.06524253,\n \"container_label\": \"velit Excepteur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1235524f-656a-5b80-b29a-bef0e7d6d06d", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"reprehenderit ad in laborum sed\",\n \"item_type\": \"id nostrud ex culpa\",\n \"generic_name\": \"dolore sit\",\n \"brand_name\": \"aliquip Ut\",\n \"strength\": \"eu elit Excepteur\",\n \"dosage_form\": \"in aliqua ad dolor\",\n \"category\": \"dolor dolor aliqua sit deserunt\",\n \"unit_of_measure\": \"non minim nisi\",\n \"upc\": \"Ut esse\",\n \"nafdac_no\": \"consectetur ullamco sed dolore\",\n \"ndc\": \"veniam fugiat la\",\n \"default_sale_price\": -37527765.007689595,\n \"container_quantity\": -94176407.06524253,\n \"container_label\": \"velit Excepteur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36db5b27-0fbb-5ad8-bc74-9c4157741b37", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"reprehenderit ad in laborum sed\",\n \"item_type\": \"id nostrud ex culpa\",\n \"generic_name\": \"dolore sit\",\n \"brand_name\": \"aliquip Ut\",\n \"strength\": \"eu elit Excepteur\",\n \"dosage_form\": \"in aliqua ad dolor\",\n \"category\": \"dolor dolor aliqua sit deserunt\",\n \"unit_of_measure\": \"non minim nisi\",\n \"upc\": \"Ut esse\",\n \"nafdac_no\": \"consectetur ullamco sed dolore\",\n \"ndc\": \"veniam fugiat la\",\n \"default_sale_price\": -37527765.007689595,\n \"container_quantity\": -94176407.06524253,\n \"container_label\": \"velit Excepteur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa3b64b2-ea6b-5ad0-8b1a-16cba7bd6de6", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"reprehenderit ad in laborum sed\",\n \"item_type\": \"id nostrud ex culpa\",\n \"generic_name\": \"dolore sit\",\n \"brand_name\": \"aliquip Ut\",\n \"strength\": \"eu elit Excepteur\",\n \"dosage_form\": \"in aliqua ad dolor\",\n \"category\": \"dolor dolor aliqua sit deserunt\",\n \"unit_of_measure\": \"non minim nisi\",\n \"upc\": \"Ut esse\",\n \"nafdac_no\": \"consectetur ullamco sed dolore\",\n \"ndc\": \"veniam fugiat la\",\n \"default_sale_price\": -37527765.007689595,\n \"container_quantity\": -94176407.06524253,\n \"container_label\": \"velit Excepteur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76f2ecbf-c6a0-597e-967d-2fbb11aa708b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"reprehenderit ad in laborum sed\",\n \"item_type\": \"id nostrud ex culpa\",\n \"generic_name\": \"dolore sit\",\n \"brand_name\": \"aliquip Ut\",\n \"strength\": \"eu elit Excepteur\",\n \"dosage_form\": \"in aliqua ad dolor\",\n \"category\": \"dolor dolor aliqua sit deserunt\",\n \"unit_of_measure\": \"non minim nisi\",\n \"upc\": \"Ut esse\",\n \"nafdac_no\": \"consectetur ullamco sed dolore\",\n \"ndc\": \"veniam fugiat la\",\n \"default_sale_price\": -37527765.007689595,\n \"container_quantity\": -94176407.06524253,\n \"container_label\": \"velit Excepteur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c42e99cb-3ac6-5f97-bfcf-2318b0f1f2ce", "name": "One catalogue item.", "request": { "name": "One catalogue item.", "description": { "content": "Response is the item DIRECTLY — no `data` wrapper (see the top-level description's \"Response envelope\" note).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3305184d-9a54-513e-b5d8-ad02a9674e0b", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\",\n \"name\": \"Paracetamol 500mg Tablets\",\n \"generic_name\": \"paracetamol\",\n \"brand_name\": \"Panadol\",\n \"strength\": \"500mg\",\n \"dosage_form\": \"tablet\",\n \"category\": \"analgesic\",\n \"item_type\": \"medication\",\n \"unit_of_measure\": \"tablet\",\n \"is_active\": true,\n \"identifiers\": [\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ],\n \"retail_price\": {\n \"amount\": \"12.50\",\n \"currency\": \"NGN\"\n },\n \"updated_at\": \"2026-09-20T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9139a01e-b5c0-5f7c-a2fa-6a6d16bc28bc", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fc92922-a0b8-5615-a4f1-80ee1f796252", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35edc69b-da36-5b3c-9e22-74255f358e82", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c2adff3-5fce-5508-b599-c2ee3f5f9c52", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d56c7ecb-559d-5940-80c8-5523ff3e3150", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9f35e28-bfba-5eab-a644-46033f0b24ef", "name": "Update a catalogue item.", "request": { "name": "Update a catalogue item.", "description": { "content": "Absent field ≠ JSON null. Idempotency-Key OPTIONAL — a PATCH is naturally idempotent.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"ad voluptate cillum non\",\n \"generic_name\": \"anim Duis proident ullamco\",\n \"brand_name\": \"nostrud qui nulla incididu\",\n \"strength\": \"exercitation eiusmod cil\",\n \"dosage_form\": \"elit minim exercitatio\",\n \"category\": \"eiusmod minim do proident Duis\",\n \"unit_of_measure\": \"deserunt minim aute reprehenderit\",\n \"upc\": \"aliqua\",\n \"nafdac_no\": \"sit veniam\",\n \"ndc\": \"officia in\",\n \"default_sale_price\": 98046420.46801746,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fae02834-2469-554e-aa7f-978d757b4a73", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"ad voluptate cillum non\",\n \"generic_name\": \"anim Duis proident ullamco\",\n \"brand_name\": \"nostrud qui nulla incididu\",\n \"strength\": \"exercitation eiusmod cil\",\n \"dosage_form\": \"elit minim exercitatio\",\n \"category\": \"eiusmod minim do proident Duis\",\n \"unit_of_measure\": \"deserunt minim aute reprehenderit\",\n \"upc\": \"aliqua\",\n \"nafdac_no\": \"sit veniam\",\n \"ndc\": \"officia in\",\n \"default_sale_price\": 98046420.46801746,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:4277495c-013e-fe82-f124-cf07359796d8\",\n \"name\": \"ad\",\n \"is_active\": true,\n \"identifiers\": [\n {\n \"system\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"system\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ],\n \"generic_name\": \"dolore nostrud\",\n \"brand_name\": \"ea ve\",\n \"strength\": \"pariatur laborum adipisicing\",\n \"dosage_form\": \"commodo occaecat elit mollit laborum\",\n \"category\": \"dolor sint aliqua incididunt\",\n \"item_type\": \"cillum\",\n \"unit_of_measure\": \"minim culpa\",\n \"retail_price\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"updated_at\": \"2013-07-03T11:17:46.429Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f1fdd5a-4a61-5b8e-b32b-074def05e01e", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"ad voluptate cillum non\",\n \"generic_name\": \"anim Duis proident ullamco\",\n \"brand_name\": \"nostrud qui nulla incididu\",\n \"strength\": \"exercitation eiusmod cil\",\n \"dosage_form\": \"elit minim exercitatio\",\n \"category\": \"eiusmod minim do proident Duis\",\n \"unit_of_measure\": \"deserunt minim aute reprehenderit\",\n \"upc\": \"aliqua\",\n \"nafdac_no\": \"sit veniam\",\n \"ndc\": \"officia in\",\n \"default_sale_price\": 98046420.46801746,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b8c2683-c365-5486-b970-22d264a84583", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"ad voluptate cillum non\",\n \"generic_name\": \"anim Duis proident ullamco\",\n \"brand_name\": \"nostrud qui nulla incididu\",\n \"strength\": \"exercitation eiusmod cil\",\n \"dosage_form\": \"elit minim exercitatio\",\n \"category\": \"eiusmod minim do proident Duis\",\n \"unit_of_measure\": \"deserunt minim aute reprehenderit\",\n \"upc\": \"aliqua\",\n \"nafdac_no\": \"sit veniam\",\n \"ndc\": \"officia in\",\n \"default_sale_price\": 98046420.46801746,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95bf6c12-7cca-55bf-8ddd-32a11f7bfbf7", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"ad voluptate cillum non\",\n \"generic_name\": \"anim Duis proident ullamco\",\n \"brand_name\": \"nostrud qui nulla incididu\",\n \"strength\": \"exercitation eiusmod cil\",\n \"dosage_form\": \"elit minim exercitatio\",\n \"category\": \"eiusmod minim do proident Duis\",\n \"unit_of_measure\": \"deserunt minim aute reprehenderit\",\n \"upc\": \"aliqua\",\n \"nafdac_no\": \"sit veniam\",\n \"ndc\": \"officia in\",\n \"default_sale_price\": 98046420.46801746,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e328f651-0bfa-5937-8b73-7b6d79e2ad09", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"ad voluptate cillum non\",\n \"generic_name\": \"anim Duis proident ullamco\",\n \"brand_name\": \"nostrud qui nulla incididu\",\n \"strength\": \"exercitation eiusmod cil\",\n \"dosage_form\": \"elit minim exercitatio\",\n \"category\": \"eiusmod minim do proident Duis\",\n \"unit_of_measure\": \"deserunt minim aute reprehenderit\",\n \"upc\": \"aliqua\",\n \"nafdac_no\": \"sit veniam\",\n \"ndc\": \"officia in\",\n \"default_sale_price\": 98046420.46801746,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c554eda5-1848-5f82-9dba-1e57bb7ac88e", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"ad voluptate cillum non\",\n \"generic_name\": \"anim Duis proident ullamco\",\n \"brand_name\": \"nostrud qui nulla incididu\",\n \"strength\": \"exercitation eiusmod cil\",\n \"dosage_form\": \"elit minim exercitatio\",\n \"category\": \"eiusmod minim do proident Duis\",\n \"unit_of_measure\": \"deserunt minim aute reprehenderit\",\n \"upc\": \"aliqua\",\n \"nafdac_no\": \"sit veniam\",\n \"ndc\": \"officia in\",\n \"default_sale_price\": 98046420.46801746,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c96e133-93e5-5a96-bbab-e342899b0ac0", "name": "Availability for up to 100 items, by id or by identifier.", "request": { "name": "Availability for up to 100 items, by id or by identifier.", "description": { "content": "For a workspace TEST key this reads the workspace's seeded synthetic sandbox — same shape either way.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\"\n },\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "79424e4f-86a9-5e96-8327-33ee861fe95d", "name": "OK. One entry per requested item, in request order.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\"\n },\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\",\n \"matched\": true,\n \"band\": \"in_stock\",\n \"as_of\": \"2026-09-20T10:00:00Z\"\n },\n {\n \"item_id\": null,\n \"matched\": false,\n \"band\": null,\n \"as_of\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e187bec-bbf1-5e9b-9135-dc4c9ed561f0", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\"\n },\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9dbad4c-fd54-5c24-83f4-9db2180b617f", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\"\n },\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffd40e8b-0648-5495-8e85-27579640aa2d", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\"\n },\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "810735da-3b60-5e03-aff1-fde149a55147", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\"\n },\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "655fef4e-1b5b-5c8c-b1d6-fe2d78673a13", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\"\n },\n {\n \"system\": \"gtin\",\n \"value\": \"6001234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4633970c-80a7-5041-abe6-e815daf83e5d", "name": "Exact quantities per location and lot.", "request": { "name": "Exact quantities per location and lot.", "description": { "content": "For a workspace TEST key this reads the workspace's seeded synthetic sandbox stock, never a real clinic's — same shape either way.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "disabled": false, "key": "item_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "disabled": false, "key": "expiring_before", "value": "1984-02-27" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7bfdfe16-b564-5aef-a045-82f9e410497f", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "item_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "expiring_before", "value": "1984-02-27" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\",\n \"location_id\": \"6a9f7e3e-2b5a-4a86-8f0d-4a6a2b3c9a11\",\n \"lot_id\": \"lot_2026_09\",\n \"quantity\": \"48\",\n \"reserved_quantity\": \"5\",\n \"expiry_date\": \"2027-03-01\",\n \"lot_status\": \"active\",\n \"as_of\": \"2026-09-20T10:00:00Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e934a75d-5755-5cd4-a039-9945b8b7cf37", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "item_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "expiring_before", "value": "1984-02-27" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dd16f86-f939-5f9b-a1f2-6008e2c76bf0", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "item_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "expiring_before", "value": "1984-02-27" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2a78747-155f-5b2f-a425-77d3249b6837", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "item_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "expiring_before", "value": "1984-02-27" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7f8620-23b8-59a5-8afb-17a492fb4a90", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "item_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "expiring_before", "value": "1984-02-27" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef443123-fbc7-5269-b7e5-cc5ffd42637c", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "item_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "expiring_before", "value": "1984-02-27" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8d5ce83-cfd5-5195-9908-56e5f99bb3be", "name": "Upload a batch of external stock quantities/bands for a pharmacy selling through another till.", "request": { "name": "Upload a batch of external stock quantities/bands for a pharmacy selling through another till.", "description": { "content": "Clinic-owned key only — an organization never pushes a clinic's own stock. batch_id doubles as the idempotency key (a replay of an already-processed batch returns the stored result, never reprocesses). Unmatched rows are counted, never guessed at, never written. A structurally invalid or suspiciously-shrunk batch is rejected (409) — nothing is written to the mirror.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "external-stock", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"465cd806-98c6-6de9-ee03-b4cb8c1ce60f\",\n \"as_of\": \"1960-09-28T21:19:26.165Z\",\n \"feed_source\": \"ea esse\",\n \"rows\": [\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 5428250.506520271,\n \"band\": \"null\"\n },\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 23807480.465620756,\n \"band\": \"out\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5bdd662e-a4fb-57a2-a19c-692dd97a07e4", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"465cd806-98c6-6de9-ee03-b4cb8c1ce60f\",\n \"as_of\": \"1960-09-28T21:19:26.165Z\",\n \"feed_source\": \"ea esse\",\n \"rows\": [\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 5428250.506520271,\n \"band\": \"null\"\n },\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 23807480.465620756,\n \"band\": \"out\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": false,\n \"batch_id\": \"urn:uuid:fc2131cc-edef-0017-2142-85a475bac8d1\",\n \"item_count\": -86001038,\n \"matched_count\": -45164587,\n \"unmatched_count\": 38859334,\n \"rejected\": false,\n \"rejected_reason\": \"suspicious_shrink\",\n \"replayed\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d045996a-669b-5aa2-bb43-bdc55f404de1", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"465cd806-98c6-6de9-ee03-b4cb8c1ce60f\",\n \"as_of\": \"1960-09-28T21:19:26.165Z\",\n \"feed_source\": \"ea esse\",\n \"rows\": [\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 5428250.506520271,\n \"band\": \"null\"\n },\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 23807480.465620756,\n \"band\": \"out\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c5e7b82-f114-5aa7-b8bb-0137139dae9c", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"465cd806-98c6-6de9-ee03-b4cb8c1ce60f\",\n \"as_of\": \"1960-09-28T21:19:26.165Z\",\n \"feed_source\": \"ea esse\",\n \"rows\": [\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 5428250.506520271,\n \"band\": \"null\"\n },\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 23807480.465620756,\n \"band\": \"out\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c97a8b-2137-5903-a9f3-4c791670e658", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"465cd806-98c6-6de9-ee03-b4cb8c1ce60f\",\n \"as_of\": \"1960-09-28T21:19:26.165Z\",\n \"feed_source\": \"ea esse\",\n \"rows\": [\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 5428250.506520271,\n \"band\": \"null\"\n },\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 23807480.465620756,\n \"band\": \"out\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e4aa783-2642-5673-b76c-c11db66afbf1", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"465cd806-98c6-6de9-ee03-b4cb8c1ce60f\",\n \"as_of\": \"1960-09-28T21:19:26.165Z\",\n \"feed_source\": \"ea esse\",\n \"rows\": [\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 5428250.506520271,\n \"band\": \"null\"\n },\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 23807480.465620756,\n \"band\": \"out\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fdb3bcc-b7ae-5aa8-a2c7-f0cfd369c476", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"465cd806-98c6-6de9-ee03-b4cb8c1ce60f\",\n \"as_of\": \"1960-09-28T21:19:26.165Z\",\n \"feed_source\": \"ea esse\",\n \"rows\": [\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 5428250.506520271,\n \"band\": \"null\"\n },\n {\n \"identifiers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"quantity\": 23807480.465620756,\n \"band\": \"out\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39c68a4c-1894-5452-8936-358241d1854c", "name": "The stored batch's own status and counts — never the row-level data.", "request": { "name": "The stored batch's own status and counts — never the row-level data.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "inventory", "external-stock", "batches", ":batch_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "batch_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "46259437-30ba-51ef-86a8-fa878f0613ec", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches", ":batch_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "batch_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"batch_id\": \"urn:uuid:7ea85dc4-6109-f754-e6ff-9663b0caf209\",\n \"status\": \"rejected\",\n \"feed_source\": \"nisi dolor\",\n \"as_of\": \"1992-07-01T23:36:47.837Z\",\n \"item_count\": -99971645,\n \"matched_count\": -79201712,\n \"unmatched_count\": 72789226,\n \"rejected_reason\": \"cupidatat dolore laboris in\",\n \"created_at\": \"1995-09-05T14:50:05.463Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56867e13-8e6c-53ab-a6b5-691d1a2778bf", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches", ":batch_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "batch_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0035f910-656a-5741-822e-9e364fd04838", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches", ":batch_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "batch_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57aafcba-c1ca-5466-b8f3-18d3ae2e34c5", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches", ":batch_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "batch_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "455dea54-df39-5247-8ba6-e565b04ec09d", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "external-stock", "batches", ":batch_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "batch_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df968900-7046-5d5c-a1c6-7264624313f4", "name": "Archive an item. Soft only — refused (item_has_stock) while any stock remains. No delete route exists, ever.", "request": { "name": "Archive an item. Soft only — refused (item_has_stock) while any stock remains. No delete route exists, ever.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "inventory", "items", ":item_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "137dbd9f-bcba-5481-bc92-8cefdd1ddaf2", "name": "OK. The archived item, directly — no data wrapper.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"383d2060-0fa1-8280-b283-2d52267278bd\",\n \"name\": \"t\",\n \"is_active\": false,\n \"identifiers\": [\n {\n \"system\": \"gtin\",\n \"value\": \"in culpa Duis\"\n },\n {\n \"system\": \"nafdac\",\n \"value\": \"in non\"\n }\n ],\n \"generic_name\": \"do Lorem mollit\",\n \"brand_name\": \"ea laboris sint\",\n \"strength\": \"ullamco reprehenderit proident sit qui\",\n \"dosage_form\": \"id velit\",\n \"category\": \"veniam fugiat aliqua esse\",\n \"item_type\": \"occaecat aliquip Ut anim\",\n \"unit_of_measure\": \"id velit sed\",\n \"retail_price\": {\n \"amount\": \"in cillum\",\n \"currency\": \"exercitation cillum deserunt ei\"\n },\n \"updated_at\": \"1978-01-26T16:43:10.851Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f92df037-73a5-5b74-97f8-4b89f1c1cf0c", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a81c7f76-a051-5f0f-9ef8-850fb0df16c8", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a3405cb-0a8a-5c66-bd15-56270baba4c2", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c81b53f-c555-50d1-bbea-20758978c014", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d020de1-763e-5098-8900-97f591a17418", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "items", ":item_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81351666-6a09-5a41-8167-4c35820ce14a", "name": "Receive stock into a lot at a location, through the ledger.", "request": { "name": "Receive stock into a lot at a location, through the ledger.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "61702599-ee6d-5447-b0f3-933d44645dda", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"transaction_id\": \"f2bfc205-755f-4a1e-0595-13c23020c4ae\",\n \"item_id\": \"d9367c6c-e0dd-fc5c-a2a7-dfbeb271f451\",\n \"location_id\": \"urn:uuid:184d14eb-20ae-5bcf-0f50-b0b85eea6ac8\",\n \"lot_id\": \"et reprehenderit do\",\n \"quantity\": \"eu do fugiat et dolor\",\n \"idempotent_replay\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaf5520a-74da-57a9-b341-44c9f6a494a7", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6761787c-f802-5b3b-987e-5f490baeb6dc", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86d1e859-07ac-5332-a429-3742d6699415", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e91ef6f-f333-5739-bf23-87a847b9d90d", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f634d8a-4db0-5255-9c31-22a268708bfd", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b353ceb5-065d-5fbd-80ba-4ed811982be9", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "receive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"cd3a95c5-259c-45d1-43d0-77960efcee92\",\n \"location_id\": \"urn:uuid:f5ef0b43-6c7a-e3d2-a6a5-da8afcd3a51c\",\n \"quantity\": 33808990.800753236,\n \"lot_number\": \"do Excepteur non ut\",\n \"expiry_date\": \"1999-04-27\",\n \"unit_cost\": -45236356.60298169,\n \"vendor_id\": \"urn:uuid:cecb4009-7c06-cd2f-d730-cd8a0ed92f30\",\n \"reference\": \"labore in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddbd356f-38a1-551c-9bc2-a113a80107e9", "name": "Adjust stock on one lot, through the ledger. A reason is required.", "request": { "name": "Adjust stock on one lot, through the ledger. A reason is required.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a6491e06-e734-5d30-8b1a-5638c3953691", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"transaction_id\": \"f2bfc205-755f-4a1e-0595-13c23020c4ae\",\n \"item_id\": \"d9367c6c-e0dd-fc5c-a2a7-dfbeb271f451\",\n \"location_id\": \"urn:uuid:184d14eb-20ae-5bcf-0f50-b0b85eea6ac8\",\n \"lot_id\": \"et reprehenderit do\",\n \"quantity\": \"eu do fugiat et dolor\",\n \"idempotent_replay\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a841059d-54d0-56e3-8c39-2ba170e8d62d", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3694c88f-c6e7-52f6-96f5-9ad7da9a96d5", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a246890e-c6ea-54e2-9e32-f3a9044d5541", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c45e460-c4c1-55b0-beb9-e15800143661", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ca75073-d942-535a-b1e4-47703867dbaa", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04cb6198-5c16-5c57-9825-3595225c7a9f", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"7e9e0337-5d7a-b8cc-472a-2478ff90e0da\",\n \"location_id\": \"urn:uuid:b30867da-2ff6-f9da-1def-6a6ff951ab5f\",\n \"lot_id\": \"urn:uuid:82d75fe6-83e5-13ce-d4bc-3785e30dc22a\",\n \"delta\": -73493699.0775168,\n \"reason\": \"non exercitation\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "522c1666-040a-59d1-91c7-c785d8d9e8d5", "name": "Transfer stock between two of this clinic's own active locations.", "request": { "name": "Transfer stock between two of this clinic's own active locations.", "description": { "content": "Every controlled drug is refused outright — an API key has no witness identity to offer.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "385f64d0-cff5-5e5c-805c-2abb338789b6", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"transaction_id\": \"f2bfc205-755f-4a1e-0595-13c23020c4ae\",\n \"item_id\": \"d9367c6c-e0dd-fc5c-a2a7-dfbeb271f451\",\n \"location_id\": \"urn:uuid:184d14eb-20ae-5bcf-0f50-b0b85eea6ac8\",\n \"lot_id\": \"et reprehenderit do\",\n \"quantity\": \"eu do fugiat et dolor\",\n \"idempotent_replay\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "186ddab1-e0e2-5c59-95f1-d3d9740a5cad", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44243823-bfd9-5f67-b915-ecbcee319570", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "883488ba-b019-5176-80f8-646003f77e34", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1082606f-42e1-548f-b6fc-d8aa5e08744b", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dd15252-54d6-5317-8c04-a86d03f0a1ac", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36e2bda0-f2f5-550f-905a-76ead9d63ec2", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_id\": \"6a53c52c-0d70-a8c2-4b71-7b32a5055b7d\",\n \"from_location_id\": \"urn:uuid:50cb362e-d39f-fd13-c299-1c16df7b1825\",\n \"to_location_id\": \"c4cf774e-908b-9ec7-3172-2dd2fad84faa\",\n \"quantity\": 90765171.96372151\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f74dfb5-4b44-518c-8197-244ad9f3fce2", "name": "Upload up to 1,000 of a partner's own medicine codes. An exact identifier match links automatically; the rest wait for review.", "request": { "name": "Upload up to 1,000 of a partner's own medicine codes. An exact identifier match links automatically; the rest wait for review.", "description": { "content": "Idempotent by construction — Idempotency-Key optional. Unknown per-row fields are refused by name WITHOUT aborting the rest of the batch.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"code\": \"Duis commodo proident\",\n \"barcode\": \"laborum in sint ex ea\",\n \"nafdac_no\": \"irure cil\",\n \"ndc\": \"culpa laborum nulla anim\",\n \"rxcui\": \"ipsum incididunt eu\",\n \"name\": \"qui eu l\",\n \"strength\": \"in elit consectetur Duis deserunt\",\n \"form\": \"nostrud ut\",\n \"pack_size\": \"ad quis in cupidatat et\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e4ad7515-129f-5232-bd8c-e81039294d04", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"code\": \"Duis commodo proident\",\n \"barcode\": \"laborum in sint ex ea\",\n \"nafdac_no\": \"irure cil\",\n \"ndc\": \"culpa laborum nulla anim\",\n \"rxcui\": \"ipsum incididunt eu\",\n \"name\": \"qui eu l\",\n \"strength\": \"in elit consectetur Duis deserunt\",\n \"form\": \"nostrud ut\",\n \"pack_size\": \"ad quis in cupidatat et\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"code\": \"fugiat\",\n \"state\": \"linked\",\n \"reason\": \"Ut\"\n },\n {\n \"code\": \"deserunt Lorem elit\",\n \"state\": \"linked\",\n \"reason\": \"dolor\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e69a314a-a1d6-5187-a137-a6e99db464a6", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"code\": \"Duis commodo proident\",\n \"barcode\": \"laborum in sint ex ea\",\n \"nafdac_no\": \"irure cil\",\n \"ndc\": \"culpa laborum nulla anim\",\n \"rxcui\": \"ipsum incididunt eu\",\n \"name\": \"qui eu l\",\n \"strength\": \"in elit consectetur Duis deserunt\",\n \"form\": \"nostrud ut\",\n \"pack_size\": \"ad quis in cupidatat et\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03ff581c-9e8d-53ba-b56e-af5148eb47ca", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"code\": \"Duis commodo proident\",\n \"barcode\": \"laborum in sint ex ea\",\n \"nafdac_no\": \"irure cil\",\n \"ndc\": \"culpa laborum nulla anim\",\n \"rxcui\": \"ipsum incididunt eu\",\n \"name\": \"qui eu l\",\n \"strength\": \"in elit consectetur Duis deserunt\",\n \"form\": \"nostrud ut\",\n \"pack_size\": \"ad quis in cupidatat et\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03063cc9-a605-5a99-9249-c9319ffbdf26", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"code\": \"Duis commodo proident\",\n \"barcode\": \"laborum in sint ex ea\",\n \"nafdac_no\": \"irure cil\",\n \"ndc\": \"culpa laborum nulla anim\",\n \"rxcui\": \"ipsum incididunt eu\",\n \"name\": \"qui eu l\",\n \"strength\": \"in elit consectetur Duis deserunt\",\n \"form\": \"nostrud ut\",\n \"pack_size\": \"ad quis in cupidatat et\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2feae98b-824d-5670-8cbb-2ae87a2a7eac", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"code\": \"Duis commodo proident\",\n \"barcode\": \"laborum in sint ex ea\",\n \"nafdac_no\": \"irure cil\",\n \"ndc\": \"culpa laborum nulla anim\",\n \"rxcui\": \"ipsum incididunt eu\",\n \"name\": \"qui eu l\",\n \"strength\": \"in elit consectetur Duis deserunt\",\n \"form\": \"nostrud ut\",\n \"pack_size\": \"ad quis in cupidatat et\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "376d3461-bc84-53df-a0ec-d3ad1902c752", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"entries\": [\n {\n \"code\": \"Duis commodo proident\",\n \"barcode\": \"laborum in sint ex ea\",\n \"nafdac_no\": \"irure cil\",\n \"ndc\": \"culpa laborum nulla anim\",\n \"rxcui\": \"ipsum incididunt eu\",\n \"name\": \"qui eu l\",\n \"strength\": \"in elit consectetur Duis deserunt\",\n \"form\": \"nostrud ut\",\n \"pack_size\": \"ad quis in cupidatat et\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5dbfd68f-6772-5127-838f-cbd830330aa1", "name": "This caller's own uploaded code list.", "request": { "name": "This caller's own uploaded code list.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "state", "value": "rejected" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "be621e9f-837a-5797-9f99-68bf0936bbed", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "rejected" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"0c756656-282f-f5d1-aa6d-b7002bc8263d\",\n \"state\": \"linked\",\n \"code\": \"ea\",\n \"barcode\": \"nisi ullamco\",\n \"nafdac_no\": \"sunt aliquip ut culpa nulla\",\n \"ndc\": \"in officia non\",\n \"rxcui\": \"fugiat nisi eu\",\n \"name\": \"incididunt Excepteur id\",\n \"strength\": \"officia et sed veniam ad\",\n \"form\": \"ipsum sit nulla eu\",\n \"pack_size\": \"cupidatat sunt v\",\n \"resolved_medicine_index_id\": \"cb2d9844-5969-e33f-e74c-2a99c8a3f59c\",\n \"candidate_medicine_index_ids\": [\n \"4b42e9b4-f631-bdb7-a6c7-e664eb4dadeb\",\n \"urn:uuid:04b2bf20-4af9-1e26-5800-351a1929813e\"\n ],\n \"review_reason\": \"tempor sit anim\",\n \"created_at\": \"1977-05-27T23:15:54.083Z\",\n \"updated_at\": \"1998-01-16T09:37:54.114Z\"\n },\n {\n \"id\": \"b83a9866-2cd4-650e-f043-8cc0d1ab1e53\",\n \"state\": \"unmatched\",\n \"code\": \"veniam\",\n \"barcode\": \"reprehenderit dolor elit proident\",\n \"nafdac_no\": \"pariatur elit\",\n \"ndc\": \"labore commodo\",\n \"rxcui\": \"id ea aute\",\n \"name\": \"non\",\n \"strength\": \"cillum voluptate ea\",\n \"form\": \"ullamco ea sit aute\",\n \"pack_size\": \"laborum labore aute\",\n \"resolved_medicine_index_id\": \"047ec2c0-2609-82a3-e7dc-3dc58d3372a0\",\n \"candidate_medicine_index_ids\": [\n \"urn:uuid:09a46114-f1e4-b5bc-e7be-b6aea8272a1a\",\n \"urn:uuid:e55fc0f0-456e-b38b-3f42-25c8f51f368a\"\n ],\n \"review_reason\": \"adipisicing\",\n \"created_at\": \"1956-11-04T00:18:04.163Z\",\n \"updated_at\": \"1991-05-30T20:06:21.437Z\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"cupidatat sit fugiat\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4329b8df-741b-525a-bcd1-f8773ccd44f7", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "rejected" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96c96bb-4445-5954-a3a9-c69028baad7c", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "rejected" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2334bfc1-2cb8-5564-9466-e9c45f899329", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "rejected" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8511cf84-6e94-5c8c-b5f9-f00bd8b6e46f", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "rejected" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f688e2ba-9f52-58db-ab33-6d80cc0fb914", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "rejected" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd114dde-ed4e-5b8e-9d47-7cfbf7a5f86d", "name": "Get one uploaded code row.", "request": { "name": "Get one uploaded code row.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c88946a4-35cd-556f-9b31-e8f0358a32f3", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e4748ae9-25ed-cd9d-a7be-ec723012fac8\",\n \"state\": \"linked\",\n \"code\": \"anim elit ut magna occaecat\",\n \"barcode\": \"tempor ut anim\",\n \"nafdac_no\": \"veniam ad\",\n \"ndc\": \"et ut Lorem enim\",\n \"rxcui\": \"in cillum minim\",\n \"name\": \"ad pariatur\",\n \"strength\": \"dolore \",\n \"form\": \"aute\",\n \"pack_size\": \"consectetur do eiusmod\",\n \"resolved_medicine_index_id\": \"urn:uuid:d523e726-1c98-9cc5-773e-9ef2e00c50ec\",\n \"candidate_medicine_index_ids\": [\n \"257bf78e-5117-d961-62be-eb66ebea668e\",\n \"12d26083-69b6-df58-32eb-0bea0956897f\"\n ],\n \"review_reason\": \"p\",\n \"created_at\": \"1952-10-25T15:23:18.131Z\",\n \"updated_at\": \"2015-03-03T18:44:43.399Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94d202b8-3b2d-5d30-9cc5-408fc3632cd8", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b05bac23-ffd9-5e09-bca3-ae61c64f8035", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "791d0571-7207-516a-9c22-75db18f87c5d", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f498776-d34c-5cbf-9679-122fb8d5dff5", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04f5a880-eb0a-5fa0-8efa-1f1d6576a753", "name": "Delete one uploaded code row.", "request": { "name": "Delete one uploaded code row.", "description": { "content": "A zero-row match is not_found, never reported as a false success.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "055d355b-a7b7-527b-af1d-5a2c92b11077", "name": "OK. The deleted row's id, directly — no data wrapper.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"urn:uuid:e2490fa1-9bac-d638-a7dd-a3b2d1acc1c7\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f209a086-05e5-5513-9366-bcf9a31ea0d8", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cdb0867-b999-577a-9a58-f75ec6512944", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12e4d0ef-0e79-5efc-87ef-807c636ef428", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaab0dca-680b-5c6f-83c5-a854b1279a18", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "inventory", "codes", ":code_entry_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "code_entry_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "86cfa72c-3fd0-56c6-bdbd-2fad1e4a95f2", "name": "Listing", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c0e3a1d3-7055-5361-a3d1-8bd47e2e140c", "name": "Every pharmacy this key's workspace can reach through an active listing connection.", "request": { "name": "Every pharmacy this key's workspace can reach through an active listing connection.", "description": { "content": "No clinic in the path — the calling key's organization must hold an ACTIVE connection granting listing.profile:read to each returned clinic; a clinic-owned key always gets an empty page. For a workspace TEST key this reads the workspace's own seeded fictional pharmacies instead — the same shape either way. Never an exact quantity; profile fields only.", "type": "text/plain" }, "url": { "path": [ "listings", "pharmacies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "00c9bf43-a2e7-5be4-a797-0b53301d64ec", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "listings", "pharmacies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"display_name\": \"SANDBOX Pharmacy 01\",\n \"address_line1\": \"1 Sandbox Close\",\n \"address_line2\": null,\n \"city\": \"Lagos\",\n \"region\": \"Lagos\",\n \"country\": \"NG\",\n \"postal_code\": \"100001\",\n \"pin\": {\n \"lat\": 6.51,\n \"lng\": 3.31\n },\n \"phone\": \"+2348000000001\",\n \"hours\": {\n \"monday\": {\n \"open\": \"09:00\",\n \"close\": \"18:00\",\n \"is_closed\": false\n }\n },\n \"open_now\": true\n }\n ],\n \"has_more\": false,\n \"next_cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2f9aa34-5d64-5547-be4c-b5dca276209e", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "listings", "pharmacies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5dc627d-301c-5898-9717-520ee2d1c98b", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "listings", "pharmacies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ea15c0f-ad22-56a3-aa61-54eba267b402", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "listings", "pharmacies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5f8762e-f160-539d-a59b-c6127cee0f53", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "listings", "pharmacies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "625e97e2-5815-5bca-9243-b75c16d6e23c", "name": "Search by medicine identity across every listed pharmacy this key's workspace can reach.", "request": { "name": "Search by medicine identity across every listed pharmacy this key's workspace can reach.", "description": { "content": "A clinic-owned key always gets an empty result. For a workspace TEST key this searches the workspace's own seeded fictional items instead. Fail-closed allow-list — an unlinked or excluded item never appears, code or text search alike. Never an exact quantity; band only. Capped at 50 results.", "type": "text/plain" }, "url": { "path": [ "listings", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"near\": {\n \"lat\": 6.5244,\n \"lng\": 3.3792,\n \"radius_km\": 20\n },\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ef26029-a11a-502a-bd76-2cf91fbbffd7", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "listings", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"near\": {\n \"lat\": 6.5244,\n \"lng\": 3.3792,\n \"radius_km\": 20\n },\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"display_name\": \"SANDBOX Pharmacy 01\",\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\",\n \"match\": \"text\",\n \"band\": \"in_stock\",\n \"distance_km\": 1.2,\n \"as_of\": \"2026-09-20T10:00:00Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "393fca0a-a8c3-5473-ba01-e49460376c35", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "listings", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"near\": {\n \"lat\": 6.5244,\n \"lng\": 3.3792,\n \"radius_km\": 20\n },\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e6a79ac-b152-5f1f-8093-918a0c7e8a3d", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "listings", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"near\": {\n \"lat\": 6.5244,\n \"lng\": 3.3792,\n \"radius_km\": 20\n },\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6222989-d939-5984-962d-37e91bdf1c64", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "listings", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"near\": {\n \"lat\": 6.5244,\n \"lng\": 3.3792,\n \"radius_km\": 20\n },\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f39477-bf1c-56e3-9df6-1e954385ed38", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "listings", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"near\": {\n \"lat\": 6.5244,\n \"lng\": 3.3792,\n \"radius_km\": 20\n },\n \"limit\": 25\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b749fec-70cd-585d-af0b-6fe77795cbc8", "name": "Report whether a network-search result was actually useful. No user data.", "request": { "name": "Report whether a network-search result was actually useful. No user data.", "description": { "content": "Nothing reads this yet; it is recorded for future freshness tuning.", "type": "text/plain" }, "url": { "path": [ "listings", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"outcome\": \"confirmed_available\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "acfe9579-5bdd-5951-a54c-3ea2cdb5a755", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "listings", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"outcome\": \"confirmed_available\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:fbf27a02-9f24-cce3-4b49-53cfd36e251d\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a94a5d5-3c57-5568-b1f8-c6d39518735f", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "listings", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"outcome\": \"confirmed_available\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb400a1a-0b61-5800-8783-f6409a10a16c", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "listings", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"outcome\": \"confirmed_available\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6bb25da-ed77-5cbd-b2b0-68b35aba54e2", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "listings", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"outcome\": \"confirmed_available\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "586aaaae-00e9-596d-86b2-5c7bf7b5fb01", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "listings", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item\": {\n \"q\": \"Paracetamol\"\n },\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"outcome\": \"confirmed_available\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03e43756-bdae-5dab-904d-52f72731c881", "name": "One listed pharmacy's items with bands (cache warm-up).", "request": { "name": "One listed pharmacy's items with bands (cache warm-up).", "description": { "content": "Has a clinic in the path, so it goes through the ordinary key/clinic authorization every other per-clinic route uses. Linked, listable, non-excluded items only.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "listing", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5a2ad1e2-f452-5a1d-a179-0bf67d7fda7e", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"item_id\": \"9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02\",\n \"name\": \"SANDBOX Paracetamol 500mg Tablets\",\n \"band\": \"in_stock\",\n \"as_of\": \"2026-09-20T10:00:00Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf05ed6b-81c6-591b-ba5e-59f3b4e61771", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caa3dfa6-c09e-5bde-9532-dbe58fbbaa23", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6081771c-c5dc-56b4-a11c-2ca948eeb887", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "464985a6-27b6-5585-b099-542e54c9d049", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21410655-1466-5025-9181-5d6a7c3e76a6", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2288f169-e954-5cb6-8120-b36210a716ee", "name": "One listed pharmacy's public listing profile.", "request": { "name": "One listed pharmacy's public listing profile.", "description": { "content": "Response is the profile DIRECTLY — no `data` wrapper (see the top-level description's \"Response envelope\" note). Has a clinic in the path, so it goes through the ordinary key/clinic authorization. For a workspace TEST key this reaches only that workspace's own sandbox pharmacy.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "listing", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d3a49b30-694b-55b8-b06a-300173335cbf", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clinic_id\": \"45715198-88e4-498c-8271-57e652c60246\",\n \"display_name\": \"SANDBOX Pharmacy 01\",\n \"address_line1\": \"1 Sandbox Close\",\n \"address_line2\": null,\n \"city\": \"Lagos\",\n \"region\": \"Lagos\",\n \"country\": \"NG\",\n \"postal_code\": \"100001\",\n \"pin\": {\n \"lat\": 6.51,\n \"lng\": 3.31\n },\n \"phone\": \"+2348000000001\",\n \"hours\": {\n \"monday\": {\n \"open\": \"09:00\",\n \"close\": \"18:00\",\n \"is_closed\": false\n }\n },\n \"price_opt_in\": false,\n \"profile_completed_at\": \"2026-09-20T10:00:00Z\",\n \"updated_at\": \"2026-09-20T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5025057-cd85-5668-bee2-c75dba5ad654", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14bda47d-91c8-5ecb-af4e-a92a152e5d4e", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "892d1cfb-3cc6-5b26-acb6-14dea2c1c84b", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b52aa2b-d6ba-5a55-8fb4-917ac048c342", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "listing", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bc58e25a-3279-50c2-ad81-c92c8c196a26", "name": "Patients", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ecf61276-60dd-5955-84ff-79acb6c74901", "name": "List patients in scope for this key's connection.", "request": { "name": "List patients in scope for this key's connection.", "description": { "content": "Restricted/access-controlled patients never appear.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "email", "value": "culpa qui consectetur" }, { "disabled": false, "key": "phone", "value": "culpa qui consectetur" }, { "disabled": false, "key": "mrn", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "58d9055d-38ec-56ef-90f8-92dac55f90c8", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "email", "value": "culpa qui consectetur" }, { "key": "phone", "value": "culpa qui consectetur" }, { "key": "mrn", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:bd631b63-e1e4-1824-24a6-013869f77452\",\n \"first_name\": \"eu anim\",\n \"last_name\": \"veniam Lorem\",\n \"mrn\": \"in dolore\",\n \"middle_name\": \"dolor fugiat sunt pariatur esse\",\n \"preferred_name\": \"eli\",\n \"title\": \"ut velit sed\",\n \"suffix\": \"cillum ad\",\n \"date_of_birth\": \"2015-10-16\",\n \"gender\": \"other\",\n \"marital_status\": \"null\",\n \"client_type\": \"minor\",\n \"client_status\": \"in ipsum\",\n \"is_dependent\": false,\n \"email\": \"minim pariatur\",\n \"phone\": \"dolore velit\",\n \"secondary_phone\": \"in ex eiusmod\",\n \"country\": \"commodo Excepteur\",\n \"nationality\": \"tempor esse\",\n \"occupation\": \"esse mollit est\",\n \"residential_address\": \"nulla elit\",\n \"work_address\": \"ad esse ni\",\n \"city\": \"aliquip sint\",\n \"state\": \"eu ullamco magna off\",\n \"zip\": \"velit cillum nulla sit incididunt\",\n \"next_of_kin\": {\n \"name\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n }\n },\n \"national_id\": \"proident esse officia\",\n \"preferred_language\": \"cupidatat deserunt tempor in\",\n \"referred_by\": \"dolor qui veniam officia\",\n \"referral_source_id\": \"7148a001-0fc2-a915-d3c5-8c3035e17fb2\",\n \"employment\": {\n \"status\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n },\n \"is_waitlist\": false,\n \"billing\": {\n \"individual_type\": {\n \"value\": \"\"\n },\n \"group_type\": {\n \"value\": \"\"\n }\n },\n \"sponsor_id\": \"urn:uuid:45b00910-b591-9573-d446-291cdb3a91f1\",\n \"allergies\": [\n \"Duis et eiusmod sit\",\n \"ad dolore pariatur\"\n ],\n \"medical_history\": \"ipsum\",\n \"current_medications\": [\n \"Ut ut quis\",\n \"sed\"\n ],\n \"chronic_conditions\": [\n \"mollit nulla magna\",\n \"nostrud sunt Duis\"\n ],\n \"blood_type\": \"B+\",\n \"genotype\": \"null\",\n \"family_history\": \"dolor consectetur ipsum incididunt\",\n \"smoking_status\": \"exercitation ut proident\",\n \"alcohol_use\": \"consectetur molli\",\n \"recreational_drug_use\": \"deserunt fugiat reprehenderit adipisicing laborum\",\n \"physical_activity\": \"cupidatat sint cillum\",\n \"living_arrangement\": \"in voluptate irure cillum Lorem\",\n \"has_profile_image\": false,\n \"profile_image_path\": \"cupidatat tempor mollit enim veniam\",\n \"status\": \"blocked\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:585f8d6a-1a57-5cd5-0313-8755df8301c6\",\n \"portal_access_enabled\": true,\n \"admission_status\": \"sit do magna\",\n \"couple\": {\n \"value\": \"\"\n },\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"guardians\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"notification_settings\": {\n \"value\": \"\"\n },\n \"created_at\": \"2001-12-13T12:17:08.085Z\",\n \"updated_at\": \"1978-01-28T01:11:36.669Z\"\n },\n {\n \"id\": \"urn:uuid:69e9cfdb-9dd1-c843-71d2-70337577a51d\",\n \"first_name\": \"reprehenderit in\",\n \"last_name\": \"proident sunt exercitation Du\",\n \"mrn\": \"veniam quis\",\n \"middle_name\": \"dolor nisi\",\n \"preferred_name\": \"aliquip enim in\",\n \"title\": \"amet Ut consequat pariatur\",\n \"suffix\": \"irure aute quis\",\n \"date_of_birth\": \"2015-03-08\",\n \"gender\": \"female\",\n \"marital_status\": \"null\",\n \"client_type\": \"adult\",\n \"client_status\": \"Excepteur mollit nu\",\n \"is_dependent\": true,\n \"email\": \"qui ipsum culpa voluptate\",\n \"phone\": \"commodo consectetur sint non aliquip\",\n \"secondary_phone\": \"ut sunt\",\n \"country\": \"commodo dolore exercitation\",\n \"nationality\": \"ex dolor irure\",\n \"occupation\": \"labore ullamco Excepteur do\",\n \"residential_address\": \"eiusmod exercitation adipi\",\n \"work_address\": \"culpa sunt voluptate\",\n \"city\": \"commodo incid\",\n \"state\": \"voluptate\",\n \"zip\": \"ex Ut dolore\",\n \"next_of_kin\": {\n \"name\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n }\n },\n \"national_id\": \"voluptate labore deserunt\",\n \"preferred_language\": \"deserunt quis pariatur proident\",\n \"referred_by\": \"minim\",\n \"referral_source_id\": \"e8ee4552-7718-4b90-1dab-5796445040d9\",\n \"employment\": {\n \"status\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n },\n \"is_waitlist\": false,\n \"billing\": {\n \"individual_type\": {\n \"value\": \"\"\n },\n \"group_type\": {\n \"value\": \"\"\n }\n },\n \"sponsor_id\": \"urn:uuid:7985611c-bf26-bc85-ebc0-13060f477d51\",\n \"allergies\": [\n \"irure cupidatat quis adipisicing\",\n \"tempor deserunt dolore ad\"\n ],\n \"medical_history\": \"elit\",\n \"current_medications\": [\n \"nisi elit\",\n \"non\"\n ],\n \"chronic_conditions\": [\n \"irure Ut id nisi amet\",\n \"ea deserunt\"\n ],\n \"blood_type\": \"B-\",\n \"genotype\": \"AA\",\n \"family_history\": \"mollit ut veniam reprehenderit\",\n \"smoking_status\": \"sit nostrud dolore\",\n \"alcohol_use\": \"eu enim ipsum ea\",\n \"recreational_drug_use\": \"ad esse eiusmo\",\n \"physical_activity\": \"eiusmod reprehenderit occaecat officia\",\n \"living_arrangement\": \"ullamco in anim aute\",\n \"has_profile_image\": true,\n \"profile_image_path\": \"enim o\",\n \"status\": \"active\",\n \"is_vip\": false,\n \"primary_location_id\": \"e45c2513-5cac-1c33-bc62-1f7e171a5f79\",\n \"portal_access_enabled\": false,\n \"admission_status\": \"nostrud irure\",\n \"couple\": {\n \"value\": \"\"\n },\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"guardians\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"notification_settings\": {\n \"value\": \"\"\n },\n \"created_at\": \"1947-10-14T07:13:00.799Z\",\n \"updated_at\": \"2017-02-01T15:26:28.182Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"in nisi\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb9cbc6d-1420-50c4-8e79-d02ca497bd87", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "email", "value": "culpa qui consectetur" }, { "key": "phone", "value": "culpa qui consectetur" }, { "key": "mrn", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a991f0f-0c94-5dbd-8f6c-adf91e7c7f52", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "email", "value": "culpa qui consectetur" }, { "key": "phone", "value": "culpa qui consectetur" }, { "key": "mrn", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39573b00-c4d5-5c7d-b037-d58a078c67c4", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "email", "value": "culpa qui consectetur" }, { "key": "phone", "value": "culpa qui consectetur" }, { "key": "mrn", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "764bf50c-13b0-5b65-b64c-26f6828f1d75", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "email", "value": "culpa qui consectetur" }, { "key": "phone", "value": "culpa qui consectetur" }, { "key": "mrn", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "806d4a36-d2f8-5a35-aaaf-bcccfa5be664", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "email", "value": "culpa qui consectetur" }, { "key": "phone", "value": "culpa qui consectetur" }, { "key": "mrn", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d074d796-1df5-5152-b47c-c978f47f941b", "name": "Create a patient. Possible duplicates are flagged for staff review, never silently merged or refused.", "request": { "name": "Create a patient. Possible duplicates are flagged for staff review, never silently merged or refused.", "description": { "content": "run_automations defaults false, suppressing the patient.created Agent Studio dispatch.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"aute dolor\",\n \"last_name\": \"velit Excepteur cillum ea\",\n \"client_type\": \"adult\",\n \"middle_name\": \"culpa nostrud Excepteur\",\n \"preferred_name\": \"voluptate eu\",\n \"title\": \"Duis mollit cillum ut\",\n \"suffix\": \"ut anim\",\n \"date_of_birth\": \"1998-12-31\",\n \"gender\": \"other\",\n \"marital_status\": \"single\",\n \"email\": \"rgq@h.tinq\",\n \"phone\": \"amet sit culpa pariatur magna\",\n \"secondary_phone\": \"dolore pariatur id\",\n \"country\": \"veniam exercitation aute qui commodo\",\n \"nationality\": \"eiusmod incididunt nisi id\",\n \"occupation\": \"voluptate fugiat ad consequat\",\n \"residential_address\": \"ullamco ut\",\n \"work_address\": \"dolor proident enim velit m\",\n \"city\": \"deserunt ut nostrud veniam\",\n \"state\": \"elit\",\n \"zip\": \"sed amet laborum voluptate\",\n \"next_of_kin\": {\n \"name\": \"labore reprehenderit anim incididunt\",\n \"phone\": \"eiusmod exercitation ullamco\",\n \"address\": \"non adipisicing minim\"\n },\n \"national_id\": \"irure et reprehenderit\",\n \"preferred_language\": \"consequat reprehenderit fugiat\",\n \"referred_by\": \"id laborum\",\n \"referral_source_id\": \"76787403-49b5-758e-9c15-cb1c87d9c94d\",\n \"employment\": {\n \"status\": \"sint reprehenderit qui\",\n \"company\": \"incididunt esse et\",\n \"role\": \"irure fugiat\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"urn:uuid:33bbe086-c429-7225-47b5-3f5612cdff0f\",\n \"billing\": {\n \"individual_type\": \"insurance\",\n \"group_type\": \"insurance\"\n },\n \"medical_history\": \"aliqua\",\n \"blood_type\": \"B+\",\n \"genotype\": \"AC\",\n \"family_history\": \"Ut esse\",\n \"smoking_status\": \"officia magna \",\n \"alcohol_use\": \"veniam anim elit\",\n \"recreational_drug_use\": \"sed Excepteur labore\",\n \"physical_activity\": \"cillum con\",\n \"living_arrangement\": \"et\",\n \"status\": \"blocked\",\n \"is_vip\": false,\n \"primary_location_id\": \"e78c8ce3-98c5-3e43-7beb-d24fa8ac6488\",\n \"emails\": [\n {\n \"email\": \"FiVX9hnYvkaGc@ameGdYkBQKfPCyQhPizJHpV.ef\",\n \"type\": \"Lorem\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"BkaFFrHIbX35alX@nGuMncXlFwQSYxdCykyMLtXrs.wloi\",\n \"type\": \"magna officia est\",\n \"permission\": \"email_ok\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"sit veniam ut\",\n \"type\": \"ullamco do\",\n \"permission\": \"text_voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"irure non ex eiusmod\",\n \"type\": \"voluptate\",\n \"permission\": \"no_call\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"bc2711e3-471d-909a-9141-3a22d106c079\",\n \"first_name\": \"veniam adipisicing quis tempor\",\n \"last_name\": \"minim dolore\",\n \"email\": \"Ut co\",\n \"phone\": \"tempor moll\",\n \"relationship\": \"step_parent\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"enim ut laboris\"\n },\n {\n \"guardian_id\": \"urn:uuid:2fd75534-bb97-3bce-8153-c4e9b4433d56\",\n \"first_name\": \"non commodo elit\",\n \"last_name\": \"minim\",\n \"email\": \"Lorem\",\n \"phone\": \"eu consectetur adipisicing\",\n \"relationship\": \"step_parent\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"sed in in\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d00f446c-cc3d-5d39-9406-d67ff53d6135", "name": "OK. `data` carries `duplicate_candidates` alongside the created record when a possible match was found.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"quis nostrud deserunt in\",\n \"last_name\": \"ullamco ut qui\",\n \"client_type\": \"minor\",\n \"middle_name\": \"fugiat\",\n \"preferred_name\": \"sunt mollit est pariatur\",\n \"title\": \"aute Ut\",\n \"suffix\": \"minim\",\n \"date_of_birth\": \"2008-12-28\",\n \"gender\": \"female\",\n \"marital_status\": \"separated\",\n \"email\": \"qYRmbCEiUjTE@uBJp.me\",\n \"phone\": \"au\",\n \"secondary_phone\": \"adipisicing tempor ex exercitation veniam\",\n \"country\": \"exercitation Lorem\",\n \"nationality\": \"pariatur do\",\n \"occupation\": \"laboris dolore\",\n \"residential_address\": \"cillum amet cupidatat aute\",\n \"work_address\": \"in\",\n \"city\": \"do fugiat consectet\",\n \"state\": \"Lorem exercitation\",\n \"zip\": \"consequa\",\n \"next_of_kin\": {\n \"name\": \"eu velit elit labore\",\n \"phone\": \"reprehenderit consequat aute mollit\",\n \"address\": \"deserunt ullamco labore\"\n },\n \"national_id\": \"enim est\",\n \"preferred_language\": \"eiusmod cillum sunt incididunt Lorem\",\n \"referred_by\": \"ullamco esse\",\n \"referral_source_id\": \"urn:uuid:b36ca3f0-fce2-d374-0c68-e14551868358\",\n \"employment\": {\n \"status\": \"Duis aliqua ut\",\n \"company\": \"dolore ullamco fugiat anim\",\n \"role\": \"proident adipisicing\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"2ba682a0-8bf3-b6c1-ccce-40832dfb2827\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"nostrud culpa\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AA\",\n \"family_history\": \"ut consequat\",\n \"smoking_status\": \"qui aliqua deserunt elit\",\n \"alcohol_use\": \"incididunt ea eiusmod\",\n \"recreational_drug_use\": \"laborum id\",\n \"physical_activity\": \"esse tempor ex\",\n \"living_arrangement\": \"nulla aute exercitation sint consectetur\",\n \"status\": \"inactive\",\n \"is_vip\": false,\n \"primary_location_id\": \"a9f482df-0dcd-0d19-3aa5-381b00b4ef3a\",\n \"emails\": [\n {\n \"email\": \"8NZLKS6Z@V.aafb\",\n \"type\": \"in in minim pariatur\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"AT2Rss@kCXmDnJ.njym\",\n \"type\": \"et Duis voluptate dolor\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"aliquip dolore\",\n \"type\": \"ut laboris\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"exercitation sit\",\n \"type\": \"irure voluptate adipisicing aute\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:9b5279ed-be24-0aeb-2721-323765704480\",\n \"first_name\": \"la\",\n \"last_name\": \"dolore sint\",\n \"email\": \"velit consectetur\",\n \"phone\": \"elit Excepteur\",\n \"relationship\": \"aunt_uncle\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"deserunt Excepteur qui\"\n },\n {\n \"guardian_id\": \"urn:uuid:e4b2c937-c403-cfd8-c07c-7557da750fe2\",\n \"first_name\": \"commodo laborum magna ullamco reprehende\",\n \"last_name\": \"deserunt\",\n \"email\": \"labore eu in id dolore\",\n \"phone\": \"anim aliquip\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"dolor laboris sint aute\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:5aef456b-3b9c-d8de-94ab-bb38a326984f\",\n \"first_name\": \"minim ex\",\n \"last_name\": \"in\",\n \"mrn\": \"veniam deserunt pariatur\",\n \"middle_name\": \"aute culpa\",\n \"preferred_name\": \"voluptate qui deserunt\",\n \"title\": \"mollit dolore\",\n \"suffix\": \"incididunt Lorem aute proident\",\n \"date_of_birth\": \"1956-08-01\",\n \"gender\": \"other\",\n \"marital_status\": \"single\",\n \"client_type\": \"minor\",\n \"client_status\": \"dolore pariatur ut\",\n \"is_dependent\": true,\n \"email\": \"est velit\",\n \"phone\": \"eu labore nulla\",\n \"secondary_phone\": \"voluptate dolore occaecat anim\",\n \"country\": \"qui ex ullamco magna\",\n \"nationality\": \"culpa\",\n \"occupation\": \"ea fugiat\",\n \"residential_address\": \"Lorem dolor\",\n \"work_address\": \"nostrud minim\",\n \"city\": \"enim in\",\n \"state\": \"et\",\n \"zip\": \"ipsum in\",\n \"next_of_kin\": {\n \"name\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n }\n },\n \"national_id\": \"et\",\n \"preferred_language\": \"in Lorem est\",\n \"referred_by\": \"ut amet\",\n \"referral_source_id\": \"urn:uuid:5e20d13f-5108-d435-2167-37388c0b2141\",\n \"employment\": {\n \"status\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n },\n \"is_waitlist\": false,\n \"billing\": {\n \"individual_type\": {\n \"value\": \"\"\n },\n \"group_type\": {\n \"value\": \"\"\n }\n },\n \"sponsor_id\": \"4d460355-7afc-9ced-35b2-b8bbb41d926c\",\n \"allergies\": [\n \"mollit aliquip\",\n \"enim ut\"\n ],\n \"medical_history\": \"qui eu \",\n \"current_medications\": [\n \"proident exercitation\",\n \"consectetur Lorem esse \"\n ],\n \"chronic_conditions\": [\n \"ea veniam\",\n \"laboris sit\"\n ],\n \"blood_type\": \"AB-\",\n \"genotype\": \"null\",\n \"family_history\": \"Lorem\",\n \"smoking_status\": \"id consequat\",\n \"alcohol_use\": \"ipsum sit pariatur\",\n \"recreational_drug_use\": \"do et\",\n \"physical_activity\": \"in nulla sed\",\n \"living_arrangement\": \"est irure in aute\",\n \"has_profile_image\": false,\n \"profile_image_path\": \"dolor aute anim adipisicing\",\n \"status\": \"active\",\n \"is_vip\": false,\n \"primary_location_id\": \"urn:uuid:4d46d22c-3a3a-90ba-0f90-b9b5744b0d9f\",\n \"portal_access_enabled\": true,\n \"admission_status\": \"nostrud ut occaecat\",\n \"couple\": {\n \"value\": \"\"\n },\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"guardians\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"notification_settings\": {\n \"value\": \"\"\n },\n \"created_at\": \"1978-02-24T10:29:38.333Z\",\n \"updated_at\": \"2024-01-28T10:04:22.388Z\",\n \"duplicate_candidates\": [\n {\n \"id\": \"urn:uuid:6ee93e22-d005-4a8c-dfbb-d8c2159c9aab\",\n \"mrn\": \"id cillum in qui\",\n \"first_name\": \"velit amet\",\n \"last_name\": \"officia pariatur do cill\",\n \"similarity\": 57196746.34747207\n },\n {\n \"id\": \"21cbe5cf-4ad6-17be-c4e5-493e8e343de1\",\n \"mrn\": \"ipsum laborum consequat\",\n \"first_name\": \"in elit culpa dolor\",\n \"last_name\": \"eu nulla officia est\",\n \"similarity\": 18347666.691988707\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ad59b25-00f6-5d7e-a264-909933a45711", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"quis nostrud deserunt in\",\n \"last_name\": \"ullamco ut qui\",\n \"client_type\": \"minor\",\n \"middle_name\": \"fugiat\",\n \"preferred_name\": \"sunt mollit est pariatur\",\n \"title\": \"aute Ut\",\n \"suffix\": \"minim\",\n \"date_of_birth\": \"2008-12-28\",\n \"gender\": \"female\",\n \"marital_status\": \"separated\",\n \"email\": \"qYRmbCEiUjTE@uBJp.me\",\n \"phone\": \"au\",\n \"secondary_phone\": \"adipisicing tempor ex exercitation veniam\",\n \"country\": \"exercitation Lorem\",\n \"nationality\": \"pariatur do\",\n \"occupation\": \"laboris dolore\",\n \"residential_address\": \"cillum amet cupidatat aute\",\n \"work_address\": \"in\",\n \"city\": \"do fugiat consectet\",\n \"state\": \"Lorem exercitation\",\n \"zip\": \"consequa\",\n \"next_of_kin\": {\n \"name\": \"eu velit elit labore\",\n \"phone\": \"reprehenderit consequat aute mollit\",\n \"address\": \"deserunt ullamco labore\"\n },\n \"national_id\": \"enim est\",\n \"preferred_language\": \"eiusmod cillum sunt incididunt Lorem\",\n \"referred_by\": \"ullamco esse\",\n \"referral_source_id\": \"urn:uuid:b36ca3f0-fce2-d374-0c68-e14551868358\",\n \"employment\": {\n \"status\": \"Duis aliqua ut\",\n \"company\": \"dolore ullamco fugiat anim\",\n \"role\": \"proident adipisicing\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"2ba682a0-8bf3-b6c1-ccce-40832dfb2827\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"nostrud culpa\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AA\",\n \"family_history\": \"ut consequat\",\n \"smoking_status\": \"qui aliqua deserunt elit\",\n \"alcohol_use\": \"incididunt ea eiusmod\",\n \"recreational_drug_use\": \"laborum id\",\n \"physical_activity\": \"esse tempor ex\",\n \"living_arrangement\": \"nulla aute exercitation sint consectetur\",\n \"status\": \"inactive\",\n \"is_vip\": false,\n \"primary_location_id\": \"a9f482df-0dcd-0d19-3aa5-381b00b4ef3a\",\n \"emails\": [\n {\n \"email\": \"8NZLKS6Z@V.aafb\",\n \"type\": \"in in minim pariatur\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"AT2Rss@kCXmDnJ.njym\",\n \"type\": \"et Duis voluptate dolor\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"aliquip dolore\",\n \"type\": \"ut laboris\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"exercitation sit\",\n \"type\": \"irure voluptate adipisicing aute\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:9b5279ed-be24-0aeb-2721-323765704480\",\n \"first_name\": \"la\",\n \"last_name\": \"dolore sint\",\n \"email\": \"velit consectetur\",\n \"phone\": \"elit Excepteur\",\n \"relationship\": \"aunt_uncle\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"deserunt Excepteur qui\"\n },\n {\n \"guardian_id\": \"urn:uuid:e4b2c937-c403-cfd8-c07c-7557da750fe2\",\n \"first_name\": \"commodo laborum magna ullamco reprehende\",\n \"last_name\": \"deserunt\",\n \"email\": \"labore eu in id dolore\",\n \"phone\": \"anim aliquip\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"dolor laboris sint aute\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c24ca8c7-7814-5697-be94-2039776f4920", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"quis nostrud deserunt in\",\n \"last_name\": \"ullamco ut qui\",\n \"client_type\": \"minor\",\n \"middle_name\": \"fugiat\",\n \"preferred_name\": \"sunt mollit est pariatur\",\n \"title\": \"aute Ut\",\n \"suffix\": \"minim\",\n \"date_of_birth\": \"2008-12-28\",\n \"gender\": \"female\",\n \"marital_status\": \"separated\",\n \"email\": \"qYRmbCEiUjTE@uBJp.me\",\n \"phone\": \"au\",\n \"secondary_phone\": \"adipisicing tempor ex exercitation veniam\",\n \"country\": \"exercitation Lorem\",\n \"nationality\": \"pariatur do\",\n \"occupation\": \"laboris dolore\",\n \"residential_address\": \"cillum amet cupidatat aute\",\n \"work_address\": \"in\",\n \"city\": \"do fugiat consectet\",\n \"state\": \"Lorem exercitation\",\n \"zip\": \"consequa\",\n \"next_of_kin\": {\n \"name\": \"eu velit elit labore\",\n \"phone\": \"reprehenderit consequat aute mollit\",\n \"address\": \"deserunt ullamco labore\"\n },\n \"national_id\": \"enim est\",\n \"preferred_language\": \"eiusmod cillum sunt incididunt Lorem\",\n \"referred_by\": \"ullamco esse\",\n \"referral_source_id\": \"urn:uuid:b36ca3f0-fce2-d374-0c68-e14551868358\",\n \"employment\": {\n \"status\": \"Duis aliqua ut\",\n \"company\": \"dolore ullamco fugiat anim\",\n \"role\": \"proident adipisicing\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"2ba682a0-8bf3-b6c1-ccce-40832dfb2827\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"nostrud culpa\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AA\",\n \"family_history\": \"ut consequat\",\n \"smoking_status\": \"qui aliqua deserunt elit\",\n \"alcohol_use\": \"incididunt ea eiusmod\",\n \"recreational_drug_use\": \"laborum id\",\n \"physical_activity\": \"esse tempor ex\",\n \"living_arrangement\": \"nulla aute exercitation sint consectetur\",\n \"status\": \"inactive\",\n \"is_vip\": false,\n \"primary_location_id\": \"a9f482df-0dcd-0d19-3aa5-381b00b4ef3a\",\n \"emails\": [\n {\n \"email\": \"8NZLKS6Z@V.aafb\",\n \"type\": \"in in minim pariatur\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"AT2Rss@kCXmDnJ.njym\",\n \"type\": \"et Duis voluptate dolor\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"aliquip dolore\",\n \"type\": \"ut laboris\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"exercitation sit\",\n \"type\": \"irure voluptate adipisicing aute\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:9b5279ed-be24-0aeb-2721-323765704480\",\n \"first_name\": \"la\",\n \"last_name\": \"dolore sint\",\n \"email\": \"velit consectetur\",\n \"phone\": \"elit Excepteur\",\n \"relationship\": \"aunt_uncle\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"deserunt Excepteur qui\"\n },\n {\n \"guardian_id\": \"urn:uuid:e4b2c937-c403-cfd8-c07c-7557da750fe2\",\n \"first_name\": \"commodo laborum magna ullamco reprehende\",\n \"last_name\": \"deserunt\",\n \"email\": \"labore eu in id dolore\",\n \"phone\": \"anim aliquip\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"dolor laboris sint aute\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0628d071-b4fd-5798-8065-14c74aab5c54", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"quis nostrud deserunt in\",\n \"last_name\": \"ullamco ut qui\",\n \"client_type\": \"minor\",\n \"middle_name\": \"fugiat\",\n \"preferred_name\": \"sunt mollit est pariatur\",\n \"title\": \"aute Ut\",\n \"suffix\": \"minim\",\n \"date_of_birth\": \"2008-12-28\",\n \"gender\": \"female\",\n \"marital_status\": \"separated\",\n \"email\": \"qYRmbCEiUjTE@uBJp.me\",\n \"phone\": \"au\",\n \"secondary_phone\": \"adipisicing tempor ex exercitation veniam\",\n \"country\": \"exercitation Lorem\",\n \"nationality\": \"pariatur do\",\n \"occupation\": \"laboris dolore\",\n \"residential_address\": \"cillum amet cupidatat aute\",\n \"work_address\": \"in\",\n \"city\": \"do fugiat consectet\",\n \"state\": \"Lorem exercitation\",\n \"zip\": \"consequa\",\n \"next_of_kin\": {\n \"name\": \"eu velit elit labore\",\n \"phone\": \"reprehenderit consequat aute mollit\",\n \"address\": \"deserunt ullamco labore\"\n },\n \"national_id\": \"enim est\",\n \"preferred_language\": \"eiusmod cillum sunt incididunt Lorem\",\n \"referred_by\": \"ullamco esse\",\n \"referral_source_id\": \"urn:uuid:b36ca3f0-fce2-d374-0c68-e14551868358\",\n \"employment\": {\n \"status\": \"Duis aliqua ut\",\n \"company\": \"dolore ullamco fugiat anim\",\n \"role\": \"proident adipisicing\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"2ba682a0-8bf3-b6c1-ccce-40832dfb2827\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"nostrud culpa\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AA\",\n \"family_history\": \"ut consequat\",\n \"smoking_status\": \"qui aliqua deserunt elit\",\n \"alcohol_use\": \"incididunt ea eiusmod\",\n \"recreational_drug_use\": \"laborum id\",\n \"physical_activity\": \"esse tempor ex\",\n \"living_arrangement\": \"nulla aute exercitation sint consectetur\",\n \"status\": \"inactive\",\n \"is_vip\": false,\n \"primary_location_id\": \"a9f482df-0dcd-0d19-3aa5-381b00b4ef3a\",\n \"emails\": [\n {\n \"email\": \"8NZLKS6Z@V.aafb\",\n \"type\": \"in in minim pariatur\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"AT2Rss@kCXmDnJ.njym\",\n \"type\": \"et Duis voluptate dolor\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"aliquip dolore\",\n \"type\": \"ut laboris\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"exercitation sit\",\n \"type\": \"irure voluptate adipisicing aute\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:9b5279ed-be24-0aeb-2721-323765704480\",\n \"first_name\": \"la\",\n \"last_name\": \"dolore sint\",\n \"email\": \"velit consectetur\",\n \"phone\": \"elit Excepteur\",\n \"relationship\": \"aunt_uncle\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"deserunt Excepteur qui\"\n },\n {\n \"guardian_id\": \"urn:uuid:e4b2c937-c403-cfd8-c07c-7557da750fe2\",\n \"first_name\": \"commodo laborum magna ullamco reprehende\",\n \"last_name\": \"deserunt\",\n \"email\": \"labore eu in id dolore\",\n \"phone\": \"anim aliquip\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"dolor laboris sint aute\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7c0542b-4487-5959-b8f3-09a33b3a76b6", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"quis nostrud deserunt in\",\n \"last_name\": \"ullamco ut qui\",\n \"client_type\": \"minor\",\n \"middle_name\": \"fugiat\",\n \"preferred_name\": \"sunt mollit est pariatur\",\n \"title\": \"aute Ut\",\n \"suffix\": \"minim\",\n \"date_of_birth\": \"2008-12-28\",\n \"gender\": \"female\",\n \"marital_status\": \"separated\",\n \"email\": \"qYRmbCEiUjTE@uBJp.me\",\n \"phone\": \"au\",\n \"secondary_phone\": \"adipisicing tempor ex exercitation veniam\",\n \"country\": \"exercitation Lorem\",\n \"nationality\": \"pariatur do\",\n \"occupation\": \"laboris dolore\",\n \"residential_address\": \"cillum amet cupidatat aute\",\n \"work_address\": \"in\",\n \"city\": \"do fugiat consectet\",\n \"state\": \"Lorem exercitation\",\n \"zip\": \"consequa\",\n \"next_of_kin\": {\n \"name\": \"eu velit elit labore\",\n \"phone\": \"reprehenderit consequat aute mollit\",\n \"address\": \"deserunt ullamco labore\"\n },\n \"national_id\": \"enim est\",\n \"preferred_language\": \"eiusmod cillum sunt incididunt Lorem\",\n \"referred_by\": \"ullamco esse\",\n \"referral_source_id\": \"urn:uuid:b36ca3f0-fce2-d374-0c68-e14551868358\",\n \"employment\": {\n \"status\": \"Duis aliqua ut\",\n \"company\": \"dolore ullamco fugiat anim\",\n \"role\": \"proident adipisicing\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"2ba682a0-8bf3-b6c1-ccce-40832dfb2827\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"nostrud culpa\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AA\",\n \"family_history\": \"ut consequat\",\n \"smoking_status\": \"qui aliqua deserunt elit\",\n \"alcohol_use\": \"incididunt ea eiusmod\",\n \"recreational_drug_use\": \"laborum id\",\n \"physical_activity\": \"esse tempor ex\",\n \"living_arrangement\": \"nulla aute exercitation sint consectetur\",\n \"status\": \"inactive\",\n \"is_vip\": false,\n \"primary_location_id\": \"a9f482df-0dcd-0d19-3aa5-381b00b4ef3a\",\n \"emails\": [\n {\n \"email\": \"8NZLKS6Z@V.aafb\",\n \"type\": \"in in minim pariatur\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"AT2Rss@kCXmDnJ.njym\",\n \"type\": \"et Duis voluptate dolor\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"aliquip dolore\",\n \"type\": \"ut laboris\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"exercitation sit\",\n \"type\": \"irure voluptate adipisicing aute\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:9b5279ed-be24-0aeb-2721-323765704480\",\n \"first_name\": \"la\",\n \"last_name\": \"dolore sint\",\n \"email\": \"velit consectetur\",\n \"phone\": \"elit Excepteur\",\n \"relationship\": \"aunt_uncle\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"deserunt Excepteur qui\"\n },\n {\n \"guardian_id\": \"urn:uuid:e4b2c937-c403-cfd8-c07c-7557da750fe2\",\n \"first_name\": \"commodo laborum magna ullamco reprehende\",\n \"last_name\": \"deserunt\",\n \"email\": \"labore eu in id dolore\",\n \"phone\": \"anim aliquip\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"dolor laboris sint aute\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb405f20-1721-59e6-a677-8854fcc6c385", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"quis nostrud deserunt in\",\n \"last_name\": \"ullamco ut qui\",\n \"client_type\": \"minor\",\n \"middle_name\": \"fugiat\",\n \"preferred_name\": \"sunt mollit est pariatur\",\n \"title\": \"aute Ut\",\n \"suffix\": \"minim\",\n \"date_of_birth\": \"2008-12-28\",\n \"gender\": \"female\",\n \"marital_status\": \"separated\",\n \"email\": \"qYRmbCEiUjTE@uBJp.me\",\n \"phone\": \"au\",\n \"secondary_phone\": \"adipisicing tempor ex exercitation veniam\",\n \"country\": \"exercitation Lorem\",\n \"nationality\": \"pariatur do\",\n \"occupation\": \"laboris dolore\",\n \"residential_address\": \"cillum amet cupidatat aute\",\n \"work_address\": \"in\",\n \"city\": \"do fugiat consectet\",\n \"state\": \"Lorem exercitation\",\n \"zip\": \"consequa\",\n \"next_of_kin\": {\n \"name\": \"eu velit elit labore\",\n \"phone\": \"reprehenderit consequat aute mollit\",\n \"address\": \"deserunt ullamco labore\"\n },\n \"national_id\": \"enim est\",\n \"preferred_language\": \"eiusmod cillum sunt incididunt Lorem\",\n \"referred_by\": \"ullamco esse\",\n \"referral_source_id\": \"urn:uuid:b36ca3f0-fce2-d374-0c68-e14551868358\",\n \"employment\": {\n \"status\": \"Duis aliqua ut\",\n \"company\": \"dolore ullamco fugiat anim\",\n \"role\": \"proident adipisicing\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"2ba682a0-8bf3-b6c1-ccce-40832dfb2827\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"nostrud culpa\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AA\",\n \"family_history\": \"ut consequat\",\n \"smoking_status\": \"qui aliqua deserunt elit\",\n \"alcohol_use\": \"incididunt ea eiusmod\",\n \"recreational_drug_use\": \"laborum id\",\n \"physical_activity\": \"esse tempor ex\",\n \"living_arrangement\": \"nulla aute exercitation sint consectetur\",\n \"status\": \"inactive\",\n \"is_vip\": false,\n \"primary_location_id\": \"a9f482df-0dcd-0d19-3aa5-381b00b4ef3a\",\n \"emails\": [\n {\n \"email\": \"8NZLKS6Z@V.aafb\",\n \"type\": \"in in minim pariatur\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"AT2Rss@kCXmDnJ.njym\",\n \"type\": \"et Duis voluptate dolor\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"aliquip dolore\",\n \"type\": \"ut laboris\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"exercitation sit\",\n \"type\": \"irure voluptate adipisicing aute\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:9b5279ed-be24-0aeb-2721-323765704480\",\n \"first_name\": \"la\",\n \"last_name\": \"dolore sint\",\n \"email\": \"velit consectetur\",\n \"phone\": \"elit Excepteur\",\n \"relationship\": \"aunt_uncle\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"deserunt Excepteur qui\"\n },\n {\n \"guardian_id\": \"urn:uuid:e4b2c937-c403-cfd8-c07c-7557da750fe2\",\n \"first_name\": \"commodo laborum magna ullamco reprehende\",\n \"last_name\": \"deserunt\",\n \"email\": \"labore eu in id dolore\",\n \"phone\": \"anim aliquip\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"dolor laboris sint aute\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40500a56-8344-5a7e-909f-42a14cf56da2", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"quis nostrud deserunt in\",\n \"last_name\": \"ullamco ut qui\",\n \"client_type\": \"minor\",\n \"middle_name\": \"fugiat\",\n \"preferred_name\": \"sunt mollit est pariatur\",\n \"title\": \"aute Ut\",\n \"suffix\": \"minim\",\n \"date_of_birth\": \"2008-12-28\",\n \"gender\": \"female\",\n \"marital_status\": \"separated\",\n \"email\": \"qYRmbCEiUjTE@uBJp.me\",\n \"phone\": \"au\",\n \"secondary_phone\": \"adipisicing tempor ex exercitation veniam\",\n \"country\": \"exercitation Lorem\",\n \"nationality\": \"pariatur do\",\n \"occupation\": \"laboris dolore\",\n \"residential_address\": \"cillum amet cupidatat aute\",\n \"work_address\": \"in\",\n \"city\": \"do fugiat consectet\",\n \"state\": \"Lorem exercitation\",\n \"zip\": \"consequa\",\n \"next_of_kin\": {\n \"name\": \"eu velit elit labore\",\n \"phone\": \"reprehenderit consequat aute mollit\",\n \"address\": \"deserunt ullamco labore\"\n },\n \"national_id\": \"enim est\",\n \"preferred_language\": \"eiusmod cillum sunt incididunt Lorem\",\n \"referred_by\": \"ullamco esse\",\n \"referral_source_id\": \"urn:uuid:b36ca3f0-fce2-d374-0c68-e14551868358\",\n \"employment\": {\n \"status\": \"Duis aliqua ut\",\n \"company\": \"dolore ullamco fugiat anim\",\n \"role\": \"proident adipisicing\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": false,\n \"sponsor_id\": \"2ba682a0-8bf3-b6c1-ccce-40832dfb2827\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"nostrud culpa\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AA\",\n \"family_history\": \"ut consequat\",\n \"smoking_status\": \"qui aliqua deserunt elit\",\n \"alcohol_use\": \"incididunt ea eiusmod\",\n \"recreational_drug_use\": \"laborum id\",\n \"physical_activity\": \"esse tempor ex\",\n \"living_arrangement\": \"nulla aute exercitation sint consectetur\",\n \"status\": \"inactive\",\n \"is_vip\": false,\n \"primary_location_id\": \"a9f482df-0dcd-0d19-3aa5-381b00b4ef3a\",\n \"emails\": [\n {\n \"email\": \"8NZLKS6Z@V.aafb\",\n \"type\": \"in in minim pariatur\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"AT2Rss@kCXmDnJ.njym\",\n \"type\": \"et Duis voluptate dolor\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"aliquip dolore\",\n \"type\": \"ut laboris\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"exercitation sit\",\n \"type\": \"irure voluptate adipisicing aute\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:9b5279ed-be24-0aeb-2721-323765704480\",\n \"first_name\": \"la\",\n \"last_name\": \"dolore sint\",\n \"email\": \"velit consectetur\",\n \"phone\": \"elit Excepteur\",\n \"relationship\": \"aunt_uncle\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"deserunt Excepteur qui\"\n },\n {\n \"guardian_id\": \"urn:uuid:e4b2c937-c403-cfd8-c07c-7557da750fe2\",\n \"first_name\": \"commodo laborum magna ullamco reprehende\",\n \"last_name\": \"deserunt\",\n \"email\": \"labore eu in id dolore\",\n \"phone\": \"anim aliquip\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"dolor laboris sint aute\"\n }\n ],\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba320704-a299-5a6b-873e-9bc8e878db12", "name": "Get one patient by id.", "request": { "name": "Get one patient by id.", "description": { "content": "A restricted patient, or one in another clinic, answers not_found — identical to absent (I-3).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0a844f6d-55fe-5ee0-9fb0-8e757109b0f3", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"cc4ec521-2d47-537f-888b-6bedd2b573e3\",\n \"first_name\": \"ullamco sint esse\",\n \"last_name\": \"voluptate nulla mollit veli\",\n \"mrn\": \"ut occaecat laboris sint\",\n \"middle_name\": \"sed et esse\",\n \"preferred_name\": \"deserunt quis\",\n \"title\": \"culpa in aliqua sed\",\n \"suffix\": \"deserunt fugiat aute quis do\",\n \"date_of_birth\": \"2010-09-28\",\n \"gender\": \"male\",\n \"marital_status\": \"married\",\n \"client_type\": \"couple\",\n \"client_status\": \"dolore ea aute Excepteur\",\n \"is_dependent\": true,\n \"email\": \"sunt sint laborum commodo reprehenderit\",\n \"phone\": \"eu aliquip aute do\",\n \"secondary_phone\": \"ut labore\",\n \"country\": \"ullamco minim\",\n \"nationality\": \"sit mollit\",\n \"occupation\": \"aute dolor sunt sint\",\n \"residential_address\": \"magna am\",\n \"work_address\": \"qui\",\n \"city\": \"cupidatat sunt\",\n \"state\": \"ad dolor est dolore\",\n \"zip\": \"in in\",\n \"next_of_kin\": {\n \"name\": \"esse aliqua anim\",\n \"phone\": \"aute commodo adipisicing\",\n \"address\": \"minim dolor veniam\"\n },\n \"national_id\": \"id pa\",\n \"preferred_language\": \"Lorem cupidatat consectetur reprehenderit eu\",\n \"referred_by\": \"com\",\n \"referral_source_id\": \"eda01f87-8044-3c9c-d15f-5f7de7be4c76\",\n \"employment\": {\n \"status\": \"incididunt minim deserunt\",\n \"company\": \"occaecat in\",\n \"role\": \"irure dolore aliqua\"\n },\n \"is_waitlist\": false,\n \"billing\": {\n \"individual_type\": \"insurance\",\n \"group_type\": \"insurance\"\n },\n \"sponsor_id\": \"25512907-f382-216d-4e2b-16ddab6a8f54\",\n \"allergies\": [\n \"non ea proident Duis\",\n \"tempor ex reprehender\"\n ],\n \"medical_history\": \"do dolore\",\n \"current_medications\": [\n \"labore\",\n \"culpa nostrud\"\n ],\n \"chronic_conditions\": [\n \"reprehenderit ut consectetur minim fugiat\",\n \"consequat ex\"\n ],\n \"blood_type\": \"null\",\n \"genotype\": \"AA\",\n \"family_history\": \"do ut\",\n \"smoking_status\": \"adipisicing proident\",\n \"alcohol_use\": \"reprehenderit aute\",\n \"recreational_drug_use\": \"commodo aute deserunt sed\",\n \"physical_activity\": \"Ut irure enim qui\",\n \"living_arrangement\": \"ut\",\n \"has_profile_image\": true,\n \"profile_image_path\": \"non consectetur\",\n \"status\": \"null\",\n \"is_vip\": false,\n \"primary_location_id\": \"urn:uuid:16024a21-d9ab-83eb-a5e5-0cdc7b27aeea\",\n \"portal_access_enabled\": true,\n \"admission_status\": \"laborum dolor proident in\",\n \"couple\": {\n \"partner_id\": {\n \"value\": \"\"\n },\n \"responsible_for_billing\": {\n \"value\": \"\"\n },\n \"relationship_status\": {\n \"value\": \"\"\n }\n },\n \"emails\": [\n {\n \"email\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n },\n {\n \"email\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n }\n ],\n \"phones\": [\n {\n \"phone_number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n },\n {\n \"phone_number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"relationship\": {\n \"value\": \"\"\n },\n \"is_responsible_for_billing\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"can_access_records\": {\n \"value\": \"\"\n },\n \"is_emergency_contact\": {\n \"value\": \"\"\n },\n \"can_schedule_appointments\": {\n \"value\": \"\"\n },\n \"notes\": {\n \"value\": \"\"\n }\n },\n {\n \"guardian_id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"relationship\": {\n \"value\": \"\"\n },\n \"is_responsible_for_billing\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"can_access_records\": {\n \"value\": \"\"\n },\n \"is_emergency_contact\": {\n \"value\": \"\"\n },\n \"can_schedule_appointments\": {\n \"value\": \"\"\n },\n \"notes\": {\n \"value\": \"\"\n }\n }\n ],\n \"notification_settings\": {\n \"upcoming_appointments_enabled\": {\n \"value\": \"\"\n },\n \"upcoming_appointments_email_option\": {\n \"value\": \"\"\n },\n \"upcoming_appointments_phone_option\": {\n \"value\": \"\"\n },\n \"incomplete_documents_enabled\": {\n \"value\": \"\"\n },\n \"incomplete_documents_email_option\": {\n \"value\": \"\"\n },\n \"incomplete_documents_phone_option\": {\n \"value\": \"\"\n },\n \"cancellations_enabled\": {\n \"value\": \"\"\n },\n \"cancellations_email_option\": {\n \"value\": \"\"\n },\n \"cancellations_phone_option\": {\n \"value\": \"\"\n }\n },\n \"created_at\": \"2015-10-11T10:26:36.777Z\",\n \"updated_at\": \"2021-05-27T19:08:35.585Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e66273-b970-5bee-b0ca-c9dc154645b0", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "759c1e6a-c55a-5eac-82c2-3deb70105c61", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "874b9ce3-6959-5d97-a578-63ca0a862d0c", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e07c0056-176f-5f86-be48-50b6190c2b46", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e96242e-1010-539a-8cab-5bffc5f4f515", "name": "Update a patient. Absent fields are unchanged; JSON null clears a nullable field.", "request": { "name": "Update a patient. Absent fields are unchanged; JSON null clears a nullable field.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"non\",\n \"last_name\": \"exercitation consequat\",\n \"middle_name\": \"incididunt cupidatat ullamco\",\n \"preferred_name\": \"ea eiusmod\",\n \"title\": \"occaecat Excepteur\",\n \"suffix\": \"ut ea\",\n \"client_type\": \"adult\",\n \"date_of_birth\": \"1979-05-14\",\n \"gender\": \"other\",\n \"marital_status\": \"null\",\n \"email\": \"7s-0QZy21Lgu-e@GQvgNctAslfyIkLWTGfAd.jen\",\n \"phone\": \"sunt cupidatat consectetur in\",\n \"secondary_phone\": \"mollit\",\n \"country\": \"laboris elit amet Duis minim\",\n \"nationality\": \"Lorem amet laborum dolore sint\",\n \"occupation\": \"e\",\n \"residential_address\": \"occa\",\n \"work_address\": \"ut irure\",\n \"city\": \"Excepteur Ut dolore\",\n \"state\": \"do sunt cillum voluptate qui\",\n \"zip\": \"enim eu nostrud dolor\",\n \"next_of_kin\": {\n \"name\": \"fugiat\",\n \"phone\": \"in nostrud labore\",\n \"address\": \"sit non id ullamco\"\n },\n \"national_id\": \"reprehend\",\n \"preferred_language\": \"tempor Lorem\",\n \"referred_by\": \"cillum ut quis\",\n \"referral_source_id\": \"urn:uuid:3a445a6f-636d-a256-c62d-57120d2af05e\",\n \"employment\": {\n \"status\": \"magna non exercitation mollit aliquip\",\n \"company\": \"culpa ut veniam\",\n \"role\": \"fugiat in\"\n },\n \"is_dependent\": true,\n \"is_waitlist\": true,\n \"sponsor_id\": \"urn:uuid:b94a3346-356c-b5a0-6561-40f26dcb26de\",\n \"billing\": {\n \"individual_type\": \"self_pay\",\n \"group_type\": \"self_pay\"\n },\n \"medical_history\": \"dolore\",\n \"blood_type\": \"O-\",\n \"genotype\": \"AS\",\n \"family_history\": \"dolor labore fugiat sint\",\n \"smoking_status\": \"deserunt qui in\",\n \"alcohol_use\": \"non ea laborum\",\n \"recreational_drug_use\": \"ipsum minim ea irure\",\n \"physical_activity\": \"nostrud sunt Lorem\",\n \"living_arrangement\": \"dolor mollit do veniam ut\",\n \"status\": \"active\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:18cb285c-b683-f8d4-4c64-1ff8369352e4\",\n \"emails\": [\n {\n \"email\": \"b7ylYQ@cqFqUMMxTanKy.lu\",\n \"type\": \"in nostrud\",\n \"permission\": \"email_ok\",\n \"is_primary\": false\n },\n {\n \"email\": \"CPACzm@yVpKiEgpybP.vu\",\n \"type\": \"nostrud labore\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"enim eu et\",\n \"type\": \"elit adipisicing et\",\n \"permission\": \"text_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"voluptate deseru\",\n \"type\": \"in\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"e6d0d361-4ddd-1cd9-2159-ac7d436dd9da\",\n \"first_name\": \"ullamco voluptate ipsum\",\n \"last_name\": \"minim commodo\",\n \"email\": \"eu veniam laborum\",\n \"phone\": \"enim Ut qui ullamco\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"sint enim\"\n },\n {\n \"guardian_id\": \"22a847ca-32f8-79ca-cb6d-0cad51ffae78\",\n \"first_name\": \"Ut Lorem Duis sint aliquip\",\n \"last_name\": \"amet exercitation do officia\",\n \"email\": \"id adipisicing aute cupida\",\n \"phone\": \"aliquip ex\",\n \"relationship\": \"parent\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"proident in exercitation ea\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "52ce9751-8426-5892-9cac-aafb2c3188a8", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"nostr\",\n \"last_name\": \"Duis eiusmod ex dolore aliquip\",\n \"middle_name\": \"nulla exercitation dolor\",\n \"preferred_name\": \"eu in elit\",\n \"title\": \"velit Ut incididunt in nisi\",\n \"suffix\": \"consequat esse\",\n \"client_type\": \"minor\",\n \"date_of_birth\": \"1980-05-26\",\n \"gender\": \"null\",\n \"marital_status\": \"married\",\n \"email\": \"AmxN@RnNR.uhst\",\n \"phone\": \"veniam laboris\",\n \"secondary_phone\": \"d\",\n \"country\": \"aute anim quis\",\n \"nationality\": \"mollit Excepteur pariatur veniam\",\n \"occupation\": \"sed commodo aliqua\",\n \"residential_address\": \"Excepteur dolor sint est\",\n \"work_address\": \"Excepteur laborum consequat labore fugiat\",\n \"city\": \"Duis occaecat\",\n \"state\": \"et in ad\",\n \"zip\": \"ea\",\n \"next_of_kin\": {\n \"name\": \"Ut in mollit labore\",\n \"phone\": \"do mini\",\n \"address\": \"u\"\n },\n \"national_id\": \"ipsum voluptate\",\n \"preferred_language\": \"ex magna esse\",\n \"referred_by\": \"aliqua velit quis incididunt\",\n \"referral_source_id\": \"urn:uuid:ee04d25f-c370-f915-98cc-e04a8ca098a8\",\n \"employment\": {\n \"status\": \"sunt irure sint qui incididunt\",\n \"company\": \"consequat sit amet ex\",\n \"role\": \"sit adipisicing magna enim\"\n },\n \"is_dependent\": false,\n \"is_waitlist\": false,\n \"sponsor_id\": \"urn:uuid:4d07413a-f8b3-e374-3e8a-93e212c77cca\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"null\"\n },\n \"medical_history\": \"qui velit labore fugiat et\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AS\",\n \"family_history\": \"tempor in\",\n \"smoking_status\": \"commodo eu\",\n \"alcohol_use\": \"in deserunt enim\",\n \"recreational_drug_use\": \"cillum Ut qui\",\n \"physical_activity\": \"est consequat do aute sint\",\n \"living_arrangement\": \"exercitation commodo\",\n \"status\": \"blocked\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:df6091c2-971a-3553-e0c6-683784d97f52\",\n \"emails\": [\n {\n \"email\": \"zG34RnmvfO@UJRnkSTzdpsbCHBpvcEtW.mkns\",\n \"type\": \"nisi ut occaecat anim adipisicing\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"w5n3srHUL@LDxZkckbxlxzISjkgixzl.nwfj\",\n \"type\": \"dolor nos\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"in aliqua\",\n \"type\": \"veniam velit\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"e\",\n \"type\": \"minim sed ut aliquip ipsum\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:119fd456-ab5b-ad9a-b16d-e27416941700\",\n \"first_name\": \"adipisicing laboris ut\",\n \"last_name\": \"minim voluptate velit\",\n \"email\": \"aute incididunt in do qui\",\n \"phone\": \"culpa Ut minim\",\n \"relationship\": \"null\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"commo\"\n },\n {\n \"guardian_id\": \"urn:uuid:aadeaddd-98c1-c0c5-a9a7-965452f8bd9a\",\n \"first_name\": \"cul\",\n \"last_name\": \"sed\",\n \"email\": \"dolor\",\n \"phone\": \"amet aute ea\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"qui eu irure\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"cc4ec521-2d47-537f-888b-6bedd2b573e3\",\n \"first_name\": \"ullamco sint esse\",\n \"last_name\": \"voluptate nulla mollit veli\",\n \"mrn\": \"ut occaecat laboris sint\",\n \"middle_name\": \"sed et esse\",\n \"preferred_name\": \"deserunt quis\",\n \"title\": \"culpa in aliqua sed\",\n \"suffix\": \"deserunt fugiat aute quis do\",\n \"date_of_birth\": \"2010-09-28\",\n \"gender\": \"male\",\n \"marital_status\": \"married\",\n \"client_type\": \"couple\",\n \"client_status\": \"dolore ea aute Excepteur\",\n \"is_dependent\": true,\n \"email\": \"sunt sint laborum commodo reprehenderit\",\n \"phone\": \"eu aliquip aute do\",\n \"secondary_phone\": \"ut labore\",\n \"country\": \"ullamco minim\",\n \"nationality\": \"sit mollit\",\n \"occupation\": \"aute dolor sunt sint\",\n \"residential_address\": \"magna am\",\n \"work_address\": \"qui\",\n \"city\": \"cupidatat sunt\",\n \"state\": \"ad dolor est dolore\",\n \"zip\": \"in in\",\n \"next_of_kin\": {\n \"name\": \"esse aliqua anim\",\n \"phone\": \"aute commodo adipisicing\",\n \"address\": \"minim dolor veniam\"\n },\n \"national_id\": \"id pa\",\n \"preferred_language\": \"Lorem cupidatat consectetur reprehenderit eu\",\n \"referred_by\": \"com\",\n \"referral_source_id\": \"eda01f87-8044-3c9c-d15f-5f7de7be4c76\",\n \"employment\": {\n \"status\": \"incididunt minim deserunt\",\n \"company\": \"occaecat in\",\n \"role\": \"irure dolore aliqua\"\n },\n \"is_waitlist\": false,\n \"billing\": {\n \"individual_type\": \"insurance\",\n \"group_type\": \"insurance\"\n },\n \"sponsor_id\": \"25512907-f382-216d-4e2b-16ddab6a8f54\",\n \"allergies\": [\n \"non ea proident Duis\",\n \"tempor ex reprehender\"\n ],\n \"medical_history\": \"do dolore\",\n \"current_medications\": [\n \"labore\",\n \"culpa nostrud\"\n ],\n \"chronic_conditions\": [\n \"reprehenderit ut consectetur minim fugiat\",\n \"consequat ex\"\n ],\n \"blood_type\": \"null\",\n \"genotype\": \"AA\",\n \"family_history\": \"do ut\",\n \"smoking_status\": \"adipisicing proident\",\n \"alcohol_use\": \"reprehenderit aute\",\n \"recreational_drug_use\": \"commodo aute deserunt sed\",\n \"physical_activity\": \"Ut irure enim qui\",\n \"living_arrangement\": \"ut\",\n \"has_profile_image\": true,\n \"profile_image_path\": \"non consectetur\",\n \"status\": \"null\",\n \"is_vip\": false,\n \"primary_location_id\": \"urn:uuid:16024a21-d9ab-83eb-a5e5-0cdc7b27aeea\",\n \"portal_access_enabled\": true,\n \"admission_status\": \"laborum dolor proident in\",\n \"couple\": {\n \"partner_id\": {\n \"value\": \"\"\n },\n \"responsible_for_billing\": {\n \"value\": \"\"\n },\n \"relationship_status\": {\n \"value\": \"\"\n }\n },\n \"emails\": [\n {\n \"email\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n },\n {\n \"email\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n }\n ],\n \"phones\": [\n {\n \"phone_number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n },\n {\n \"phone_number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"relationship\": {\n \"value\": \"\"\n },\n \"is_responsible_for_billing\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"can_access_records\": {\n \"value\": \"\"\n },\n \"is_emergency_contact\": {\n \"value\": \"\"\n },\n \"can_schedule_appointments\": {\n \"value\": \"\"\n },\n \"notes\": {\n \"value\": \"\"\n }\n },\n {\n \"guardian_id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"relationship\": {\n \"value\": \"\"\n },\n \"is_responsible_for_billing\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"can_access_records\": {\n \"value\": \"\"\n },\n \"is_emergency_contact\": {\n \"value\": \"\"\n },\n \"can_schedule_appointments\": {\n \"value\": \"\"\n },\n \"notes\": {\n \"value\": \"\"\n }\n }\n ],\n \"notification_settings\": {\n \"upcoming_appointments_enabled\": {\n \"value\": \"\"\n },\n \"upcoming_appointments_email_option\": {\n \"value\": \"\"\n },\n \"upcoming_appointments_phone_option\": {\n \"value\": \"\"\n },\n \"incomplete_documents_enabled\": {\n \"value\": \"\"\n },\n \"incomplete_documents_email_option\": {\n \"value\": \"\"\n },\n \"incomplete_documents_phone_option\": {\n \"value\": \"\"\n },\n \"cancellations_enabled\": {\n \"value\": \"\"\n },\n \"cancellations_email_option\": {\n \"value\": \"\"\n },\n \"cancellations_phone_option\": {\n \"value\": \"\"\n }\n },\n \"created_at\": \"2015-10-11T10:26:36.777Z\",\n \"updated_at\": \"2021-05-27T19:08:35.585Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b740e1c9-8c2e-5577-a99d-c45e4c18277a", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"nostr\",\n \"last_name\": \"Duis eiusmod ex dolore aliquip\",\n \"middle_name\": \"nulla exercitation dolor\",\n \"preferred_name\": \"eu in elit\",\n \"title\": \"velit Ut incididunt in nisi\",\n \"suffix\": \"consequat esse\",\n \"client_type\": \"minor\",\n \"date_of_birth\": \"1980-05-26\",\n \"gender\": \"null\",\n \"marital_status\": \"married\",\n \"email\": \"AmxN@RnNR.uhst\",\n \"phone\": \"veniam laboris\",\n \"secondary_phone\": \"d\",\n \"country\": \"aute anim quis\",\n \"nationality\": \"mollit Excepteur pariatur veniam\",\n \"occupation\": \"sed commodo aliqua\",\n \"residential_address\": \"Excepteur dolor sint est\",\n \"work_address\": \"Excepteur laborum consequat labore fugiat\",\n \"city\": \"Duis occaecat\",\n \"state\": \"et in ad\",\n \"zip\": \"ea\",\n \"next_of_kin\": {\n \"name\": \"Ut in mollit labore\",\n \"phone\": \"do mini\",\n \"address\": \"u\"\n },\n \"national_id\": \"ipsum voluptate\",\n \"preferred_language\": \"ex magna esse\",\n \"referred_by\": \"aliqua velit quis incididunt\",\n \"referral_source_id\": \"urn:uuid:ee04d25f-c370-f915-98cc-e04a8ca098a8\",\n \"employment\": {\n \"status\": \"sunt irure sint qui incididunt\",\n \"company\": \"consequat sit amet ex\",\n \"role\": \"sit adipisicing magna enim\"\n },\n \"is_dependent\": false,\n \"is_waitlist\": false,\n \"sponsor_id\": \"urn:uuid:4d07413a-f8b3-e374-3e8a-93e212c77cca\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"null\"\n },\n \"medical_history\": \"qui velit labore fugiat et\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AS\",\n \"family_history\": \"tempor in\",\n \"smoking_status\": \"commodo eu\",\n \"alcohol_use\": \"in deserunt enim\",\n \"recreational_drug_use\": \"cillum Ut qui\",\n \"physical_activity\": \"est consequat do aute sint\",\n \"living_arrangement\": \"exercitation commodo\",\n \"status\": \"blocked\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:df6091c2-971a-3553-e0c6-683784d97f52\",\n \"emails\": [\n {\n \"email\": \"zG34RnmvfO@UJRnkSTzdpsbCHBpvcEtW.mkns\",\n \"type\": \"nisi ut occaecat anim adipisicing\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"w5n3srHUL@LDxZkckbxlxzISjkgixzl.nwfj\",\n \"type\": \"dolor nos\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"in aliqua\",\n \"type\": \"veniam velit\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"e\",\n \"type\": \"minim sed ut aliquip ipsum\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:119fd456-ab5b-ad9a-b16d-e27416941700\",\n \"first_name\": \"adipisicing laboris ut\",\n \"last_name\": \"minim voluptate velit\",\n \"email\": \"aute incididunt in do qui\",\n \"phone\": \"culpa Ut minim\",\n \"relationship\": \"null\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"commo\"\n },\n {\n \"guardian_id\": \"urn:uuid:aadeaddd-98c1-c0c5-a9a7-965452f8bd9a\",\n \"first_name\": \"cul\",\n \"last_name\": \"sed\",\n \"email\": \"dolor\",\n \"phone\": \"amet aute ea\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"qui eu irure\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2096e516-ceb0-5020-8ca2-1cb9827b7fc6", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"nostr\",\n \"last_name\": \"Duis eiusmod ex dolore aliquip\",\n \"middle_name\": \"nulla exercitation dolor\",\n \"preferred_name\": \"eu in elit\",\n \"title\": \"velit Ut incididunt in nisi\",\n \"suffix\": \"consequat esse\",\n \"client_type\": \"minor\",\n \"date_of_birth\": \"1980-05-26\",\n \"gender\": \"null\",\n \"marital_status\": \"married\",\n \"email\": \"AmxN@RnNR.uhst\",\n \"phone\": \"veniam laboris\",\n \"secondary_phone\": \"d\",\n \"country\": \"aute anim quis\",\n \"nationality\": \"mollit Excepteur pariatur veniam\",\n \"occupation\": \"sed commodo aliqua\",\n \"residential_address\": \"Excepteur dolor sint est\",\n \"work_address\": \"Excepteur laborum consequat labore fugiat\",\n \"city\": \"Duis occaecat\",\n \"state\": \"et in ad\",\n \"zip\": \"ea\",\n \"next_of_kin\": {\n \"name\": \"Ut in mollit labore\",\n \"phone\": \"do mini\",\n \"address\": \"u\"\n },\n \"national_id\": \"ipsum voluptate\",\n \"preferred_language\": \"ex magna esse\",\n \"referred_by\": \"aliqua velit quis incididunt\",\n \"referral_source_id\": \"urn:uuid:ee04d25f-c370-f915-98cc-e04a8ca098a8\",\n \"employment\": {\n \"status\": \"sunt irure sint qui incididunt\",\n \"company\": \"consequat sit amet ex\",\n \"role\": \"sit adipisicing magna enim\"\n },\n \"is_dependent\": false,\n \"is_waitlist\": false,\n \"sponsor_id\": \"urn:uuid:4d07413a-f8b3-e374-3e8a-93e212c77cca\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"null\"\n },\n \"medical_history\": \"qui velit labore fugiat et\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AS\",\n \"family_history\": \"tempor in\",\n \"smoking_status\": \"commodo eu\",\n \"alcohol_use\": \"in deserunt enim\",\n \"recreational_drug_use\": \"cillum Ut qui\",\n \"physical_activity\": \"est consequat do aute sint\",\n \"living_arrangement\": \"exercitation commodo\",\n \"status\": \"blocked\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:df6091c2-971a-3553-e0c6-683784d97f52\",\n \"emails\": [\n {\n \"email\": \"zG34RnmvfO@UJRnkSTzdpsbCHBpvcEtW.mkns\",\n \"type\": \"nisi ut occaecat anim adipisicing\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"w5n3srHUL@LDxZkckbxlxzISjkgixzl.nwfj\",\n \"type\": \"dolor nos\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"in aliqua\",\n \"type\": \"veniam velit\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"e\",\n \"type\": \"minim sed ut aliquip ipsum\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:119fd456-ab5b-ad9a-b16d-e27416941700\",\n \"first_name\": \"adipisicing laboris ut\",\n \"last_name\": \"minim voluptate velit\",\n \"email\": \"aute incididunt in do qui\",\n \"phone\": \"culpa Ut minim\",\n \"relationship\": \"null\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"commo\"\n },\n {\n \"guardian_id\": \"urn:uuid:aadeaddd-98c1-c0c5-a9a7-965452f8bd9a\",\n \"first_name\": \"cul\",\n \"last_name\": \"sed\",\n \"email\": \"dolor\",\n \"phone\": \"amet aute ea\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"qui eu irure\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e3fe6c4-6df0-594b-9b7f-d8e7dc598d26", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"nostr\",\n \"last_name\": \"Duis eiusmod ex dolore aliquip\",\n \"middle_name\": \"nulla exercitation dolor\",\n \"preferred_name\": \"eu in elit\",\n \"title\": \"velit Ut incididunt in nisi\",\n \"suffix\": \"consequat esse\",\n \"client_type\": \"minor\",\n \"date_of_birth\": \"1980-05-26\",\n \"gender\": \"null\",\n \"marital_status\": \"married\",\n \"email\": \"AmxN@RnNR.uhst\",\n \"phone\": \"veniam laboris\",\n \"secondary_phone\": \"d\",\n \"country\": \"aute anim quis\",\n \"nationality\": \"mollit Excepteur pariatur veniam\",\n \"occupation\": \"sed commodo aliqua\",\n \"residential_address\": \"Excepteur dolor sint est\",\n \"work_address\": \"Excepteur laborum consequat labore fugiat\",\n \"city\": \"Duis occaecat\",\n \"state\": \"et in ad\",\n \"zip\": \"ea\",\n \"next_of_kin\": {\n \"name\": \"Ut in mollit labore\",\n \"phone\": \"do mini\",\n \"address\": \"u\"\n },\n \"national_id\": \"ipsum voluptate\",\n \"preferred_language\": \"ex magna esse\",\n \"referred_by\": \"aliqua velit quis incididunt\",\n \"referral_source_id\": \"urn:uuid:ee04d25f-c370-f915-98cc-e04a8ca098a8\",\n \"employment\": {\n \"status\": \"sunt irure sint qui incididunt\",\n \"company\": \"consequat sit amet ex\",\n \"role\": \"sit adipisicing magna enim\"\n },\n \"is_dependent\": false,\n \"is_waitlist\": false,\n \"sponsor_id\": \"urn:uuid:4d07413a-f8b3-e374-3e8a-93e212c77cca\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"null\"\n },\n \"medical_history\": \"qui velit labore fugiat et\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AS\",\n \"family_history\": \"tempor in\",\n \"smoking_status\": \"commodo eu\",\n \"alcohol_use\": \"in deserunt enim\",\n \"recreational_drug_use\": \"cillum Ut qui\",\n \"physical_activity\": \"est consequat do aute sint\",\n \"living_arrangement\": \"exercitation commodo\",\n \"status\": \"blocked\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:df6091c2-971a-3553-e0c6-683784d97f52\",\n \"emails\": [\n {\n \"email\": \"zG34RnmvfO@UJRnkSTzdpsbCHBpvcEtW.mkns\",\n \"type\": \"nisi ut occaecat anim adipisicing\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"w5n3srHUL@LDxZkckbxlxzISjkgixzl.nwfj\",\n \"type\": \"dolor nos\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"in aliqua\",\n \"type\": \"veniam velit\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"e\",\n \"type\": \"minim sed ut aliquip ipsum\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:119fd456-ab5b-ad9a-b16d-e27416941700\",\n \"first_name\": \"adipisicing laboris ut\",\n \"last_name\": \"minim voluptate velit\",\n \"email\": \"aute incididunt in do qui\",\n \"phone\": \"culpa Ut minim\",\n \"relationship\": \"null\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"commo\"\n },\n {\n \"guardian_id\": \"urn:uuid:aadeaddd-98c1-c0c5-a9a7-965452f8bd9a\",\n \"first_name\": \"cul\",\n \"last_name\": \"sed\",\n \"email\": \"dolor\",\n \"phone\": \"amet aute ea\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"qui eu irure\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f08e9100-5be1-5c27-ab4d-593c7e61d21a", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"nostr\",\n \"last_name\": \"Duis eiusmod ex dolore aliquip\",\n \"middle_name\": \"nulla exercitation dolor\",\n \"preferred_name\": \"eu in elit\",\n \"title\": \"velit Ut incididunt in nisi\",\n \"suffix\": \"consequat esse\",\n \"client_type\": \"minor\",\n \"date_of_birth\": \"1980-05-26\",\n \"gender\": \"null\",\n \"marital_status\": \"married\",\n \"email\": \"AmxN@RnNR.uhst\",\n \"phone\": \"veniam laboris\",\n \"secondary_phone\": \"d\",\n \"country\": \"aute anim quis\",\n \"nationality\": \"mollit Excepteur pariatur veniam\",\n \"occupation\": \"sed commodo aliqua\",\n \"residential_address\": \"Excepteur dolor sint est\",\n \"work_address\": \"Excepteur laborum consequat labore fugiat\",\n \"city\": \"Duis occaecat\",\n \"state\": \"et in ad\",\n \"zip\": \"ea\",\n \"next_of_kin\": {\n \"name\": \"Ut in mollit labore\",\n \"phone\": \"do mini\",\n \"address\": \"u\"\n },\n \"national_id\": \"ipsum voluptate\",\n \"preferred_language\": \"ex magna esse\",\n \"referred_by\": \"aliqua velit quis incididunt\",\n \"referral_source_id\": \"urn:uuid:ee04d25f-c370-f915-98cc-e04a8ca098a8\",\n \"employment\": {\n \"status\": \"sunt irure sint qui incididunt\",\n \"company\": \"consequat sit amet ex\",\n \"role\": \"sit adipisicing magna enim\"\n },\n \"is_dependent\": false,\n \"is_waitlist\": false,\n \"sponsor_id\": \"urn:uuid:4d07413a-f8b3-e374-3e8a-93e212c77cca\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"null\"\n },\n \"medical_history\": \"qui velit labore fugiat et\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AS\",\n \"family_history\": \"tempor in\",\n \"smoking_status\": \"commodo eu\",\n \"alcohol_use\": \"in deserunt enim\",\n \"recreational_drug_use\": \"cillum Ut qui\",\n \"physical_activity\": \"est consequat do aute sint\",\n \"living_arrangement\": \"exercitation commodo\",\n \"status\": \"blocked\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:df6091c2-971a-3553-e0c6-683784d97f52\",\n \"emails\": [\n {\n \"email\": \"zG34RnmvfO@UJRnkSTzdpsbCHBpvcEtW.mkns\",\n \"type\": \"nisi ut occaecat anim adipisicing\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"w5n3srHUL@LDxZkckbxlxzISjkgixzl.nwfj\",\n \"type\": \"dolor nos\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"in aliqua\",\n \"type\": \"veniam velit\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"e\",\n \"type\": \"minim sed ut aliquip ipsum\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:119fd456-ab5b-ad9a-b16d-e27416941700\",\n \"first_name\": \"adipisicing laboris ut\",\n \"last_name\": \"minim voluptate velit\",\n \"email\": \"aute incididunt in do qui\",\n \"phone\": \"culpa Ut minim\",\n \"relationship\": \"null\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"commo\"\n },\n {\n \"guardian_id\": \"urn:uuid:aadeaddd-98c1-c0c5-a9a7-965452f8bd9a\",\n \"first_name\": \"cul\",\n \"last_name\": \"sed\",\n \"email\": \"dolor\",\n \"phone\": \"amet aute ea\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"qui eu irure\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d517340-7fbb-539d-8f90-727bfbb0a113", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"nostr\",\n \"last_name\": \"Duis eiusmod ex dolore aliquip\",\n \"middle_name\": \"nulla exercitation dolor\",\n \"preferred_name\": \"eu in elit\",\n \"title\": \"velit Ut incididunt in nisi\",\n \"suffix\": \"consequat esse\",\n \"client_type\": \"minor\",\n \"date_of_birth\": \"1980-05-26\",\n \"gender\": \"null\",\n \"marital_status\": \"married\",\n \"email\": \"AmxN@RnNR.uhst\",\n \"phone\": \"veniam laboris\",\n \"secondary_phone\": \"d\",\n \"country\": \"aute anim quis\",\n \"nationality\": \"mollit Excepteur pariatur veniam\",\n \"occupation\": \"sed commodo aliqua\",\n \"residential_address\": \"Excepteur dolor sint est\",\n \"work_address\": \"Excepteur laborum consequat labore fugiat\",\n \"city\": \"Duis occaecat\",\n \"state\": \"et in ad\",\n \"zip\": \"ea\",\n \"next_of_kin\": {\n \"name\": \"Ut in mollit labore\",\n \"phone\": \"do mini\",\n \"address\": \"u\"\n },\n \"national_id\": \"ipsum voluptate\",\n \"preferred_language\": \"ex magna esse\",\n \"referred_by\": \"aliqua velit quis incididunt\",\n \"referral_source_id\": \"urn:uuid:ee04d25f-c370-f915-98cc-e04a8ca098a8\",\n \"employment\": {\n \"status\": \"sunt irure sint qui incididunt\",\n \"company\": \"consequat sit amet ex\",\n \"role\": \"sit adipisicing magna enim\"\n },\n \"is_dependent\": false,\n \"is_waitlist\": false,\n \"sponsor_id\": \"urn:uuid:4d07413a-f8b3-e374-3e8a-93e212c77cca\",\n \"billing\": {\n \"individual_type\": \"null\",\n \"group_type\": \"null\"\n },\n \"medical_history\": \"qui velit labore fugiat et\",\n \"blood_type\": \"A+\",\n \"genotype\": \"AS\",\n \"family_history\": \"tempor in\",\n \"smoking_status\": \"commodo eu\",\n \"alcohol_use\": \"in deserunt enim\",\n \"recreational_drug_use\": \"cillum Ut qui\",\n \"physical_activity\": \"est consequat do aute sint\",\n \"living_arrangement\": \"exercitation commodo\",\n \"status\": \"blocked\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:df6091c2-971a-3553-e0c6-683784d97f52\",\n \"emails\": [\n {\n \"email\": \"zG34RnmvfO@UJRnkSTzdpsbCHBpvcEtW.mkns\",\n \"type\": \"nisi ut occaecat anim adipisicing\",\n \"permission\": \"null\",\n \"is_primary\": false\n },\n {\n \"email\": \"w5n3srHUL@LDxZkckbxlxzISjkgixzl.nwfj\",\n \"type\": \"dolor nos\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"phones\": [\n {\n \"phone_number\": \"in aliqua\",\n \"type\": \"veniam velit\",\n \"permission\": \"voicemail_ok\",\n \"is_primary\": false\n },\n {\n \"phone_number\": \"e\",\n \"type\": \"minim sed ut aliquip ipsum\",\n \"permission\": \"null\",\n \"is_primary\": false\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": \"urn:uuid:119fd456-ab5b-ad9a-b16d-e27416941700\",\n \"first_name\": \"adipisicing laboris ut\",\n \"last_name\": \"minim voluptate velit\",\n \"email\": \"aute incididunt in do qui\",\n \"phone\": \"culpa Ut minim\",\n \"relationship\": \"null\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"commo\"\n },\n {\n \"guardian_id\": \"urn:uuid:aadeaddd-98c1-c0c5-a9a7-965452f8bd9a\",\n \"first_name\": \"cul\",\n \"last_name\": \"sed\",\n \"email\": \"dolor\",\n \"phone\": \"amet aute ea\",\n \"relationship\": \"other\",\n \"is_responsible_for_billing\": false,\n \"is_primary\": false,\n \"can_access_records\": false,\n \"is_emergency_contact\": true,\n \"can_schedule_appointments\": false,\n \"notes\": \"qui eu irure\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c505dd18-0c7f-5003-8d90-0be9dd1d3899", "name": "Archive a patient. Never a delete.", "request": { "name": "Archive a patient. Never a delete.", "description": { "content": "Sets patients.client_status = 'archived' — the SAME write the app's own archive control makes (db/actions/patients.ts::updateClientStatus). Never removes any row. Idempotent: archiving an already-archived patient succeeds again. A restricted patient, or one in another clinic, answers not_found — identical to absent (I-3).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patients", ":patient_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "91ca3a09-1c30-5922-87cb-2503c7030339", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"cc4ec521-2d47-537f-888b-6bedd2b573e3\",\n \"first_name\": \"ullamco sint esse\",\n \"last_name\": \"voluptate nulla mollit veli\",\n \"mrn\": \"ut occaecat laboris sint\",\n \"middle_name\": \"sed et esse\",\n \"preferred_name\": \"deserunt quis\",\n \"title\": \"culpa in aliqua sed\",\n \"suffix\": \"deserunt fugiat aute quis do\",\n \"date_of_birth\": \"2010-09-28\",\n \"gender\": \"male\",\n \"marital_status\": \"married\",\n \"client_type\": \"couple\",\n \"client_status\": \"dolore ea aute Excepteur\",\n \"is_dependent\": true,\n \"email\": \"sunt sint laborum commodo reprehenderit\",\n \"phone\": \"eu aliquip aute do\",\n \"secondary_phone\": \"ut labore\",\n \"country\": \"ullamco minim\",\n \"nationality\": \"sit mollit\",\n \"occupation\": \"aute dolor sunt sint\",\n \"residential_address\": \"magna am\",\n \"work_address\": \"qui\",\n \"city\": \"cupidatat sunt\",\n \"state\": \"ad dolor est dolore\",\n \"zip\": \"in in\",\n \"next_of_kin\": {\n \"name\": \"esse aliqua anim\",\n \"phone\": \"aute commodo adipisicing\",\n \"address\": \"minim dolor veniam\"\n },\n \"national_id\": \"id pa\",\n \"preferred_language\": \"Lorem cupidatat consectetur reprehenderit eu\",\n \"referred_by\": \"com\",\n \"referral_source_id\": \"eda01f87-8044-3c9c-d15f-5f7de7be4c76\",\n \"employment\": {\n \"status\": \"incididunt minim deserunt\",\n \"company\": \"occaecat in\",\n \"role\": \"irure dolore aliqua\"\n },\n \"is_waitlist\": false,\n \"billing\": {\n \"individual_type\": \"insurance\",\n \"group_type\": \"insurance\"\n },\n \"sponsor_id\": \"25512907-f382-216d-4e2b-16ddab6a8f54\",\n \"allergies\": [\n \"non ea proident Duis\",\n \"tempor ex reprehender\"\n ],\n \"medical_history\": \"do dolore\",\n \"current_medications\": [\n \"labore\",\n \"culpa nostrud\"\n ],\n \"chronic_conditions\": [\n \"reprehenderit ut consectetur minim fugiat\",\n \"consequat ex\"\n ],\n \"blood_type\": \"null\",\n \"genotype\": \"AA\",\n \"family_history\": \"do ut\",\n \"smoking_status\": \"adipisicing proident\",\n \"alcohol_use\": \"reprehenderit aute\",\n \"recreational_drug_use\": \"commodo aute deserunt sed\",\n \"physical_activity\": \"Ut irure enim qui\",\n \"living_arrangement\": \"ut\",\n \"has_profile_image\": true,\n \"profile_image_path\": \"non consectetur\",\n \"status\": \"null\",\n \"is_vip\": false,\n \"primary_location_id\": \"urn:uuid:16024a21-d9ab-83eb-a5e5-0cdc7b27aeea\",\n \"portal_access_enabled\": true,\n \"admission_status\": \"laborum dolor proident in\",\n \"couple\": {\n \"partner_id\": {\n \"value\": \"\"\n },\n \"responsible_for_billing\": {\n \"value\": \"\"\n },\n \"relationship_status\": {\n \"value\": \"\"\n }\n },\n \"emails\": [\n {\n \"email\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n },\n {\n \"email\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n }\n ],\n \"phones\": [\n {\n \"phone_number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n },\n {\n \"phone_number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n }\n ],\n \"guardians\": [\n {\n \"guardian_id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"relationship\": {\n \"value\": \"\"\n },\n \"is_responsible_for_billing\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"can_access_records\": {\n \"value\": \"\"\n },\n \"is_emergency_contact\": {\n \"value\": \"\"\n },\n \"can_schedule_appointments\": {\n \"value\": \"\"\n },\n \"notes\": {\n \"value\": \"\"\n }\n },\n {\n \"guardian_id\": {\n \"value\": \"\"\n },\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"relationship\": {\n \"value\": \"\"\n },\n \"is_responsible_for_billing\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n },\n \"can_access_records\": {\n \"value\": \"\"\n },\n \"is_emergency_contact\": {\n \"value\": \"\"\n },\n \"can_schedule_appointments\": {\n \"value\": \"\"\n },\n \"notes\": {\n \"value\": \"\"\n }\n }\n ],\n \"notification_settings\": {\n \"upcoming_appointments_enabled\": {\n \"value\": \"\"\n },\n \"upcoming_appointments_email_option\": {\n \"value\": \"\"\n },\n \"upcoming_appointments_phone_option\": {\n \"value\": \"\"\n },\n \"incomplete_documents_enabled\": {\n \"value\": \"\"\n },\n \"incomplete_documents_email_option\": {\n \"value\": \"\"\n },\n \"incomplete_documents_phone_option\": {\n \"value\": \"\"\n },\n \"cancellations_enabled\": {\n \"value\": \"\"\n },\n \"cancellations_email_option\": {\n \"value\": \"\"\n },\n \"cancellations_phone_option\": {\n \"value\": \"\"\n }\n },\n \"created_at\": \"2015-10-11T10:26:36.777Z\",\n \"updated_at\": \"2021-05-27T19:08:35.585Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32ad69d9-bb82-5787-9af1-b2817b0894af", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc58ec0b-cbe3-58ac-85f6-3371d6aaf396", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1d31131-fc3a-5343-8f82-292d2af7fab9", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b95c7960-6d4a-5fa4-8264-ebcbd0851535", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", ":patient_id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "patient_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d076e05-88ee-55e9-a67c-d14542753b0b", "name": "Possible-duplicate pairs flagged for staff review.", "request": { "name": "Possible-duplicate pairs flagged for staff review.", "description": { "content": "A sandbox (test) key always sees an empty list: the create adapter never seeds this table for a sandbox organization.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patients", "duplicate_flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "dismissed" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "15e1c04b-4881-53d1-9b06-19229c7c35a6", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "duplicate_flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "dismissed" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:e781fa86-d729-463c-5eec-b246846875a2\",\n \"clinic_patient_id\": \"e5114584-5e97-7dbc-07e7-6713242fa27c\",\n \"candidate_clinic_patient_id\": \"urn:uuid:24b0dc2a-887f-2995-9862-472d5047dc02\",\n \"status\": \"open\",\n \"similarity\": -98215873.26005101,\n \"source\": \"nostrud nulla qui\",\n \"decided_by_staff_id\": \"b632724d-359a-3e4d-613d-7d51a09e8d85\",\n \"decided_at\": \"1994-02-07T19:14:59.026Z\",\n \"created_at\": \"1998-12-10T19:50:54.724Z\"\n },\n {\n \"id\": \"e0b0080f-3fe8-4fe5-5eae-5ea0a2b38c34\",\n \"clinic_patient_id\": \"urn:uuid:ad1001f1-8600-3527-a9ca-d5993fc0b154\",\n \"candidate_clinic_patient_id\": \"urn:uuid:b8960244-ee9a-7d3e-91ea-e43086e3ec85\",\n \"status\": \"merged\",\n \"similarity\": -37370830.02924919,\n \"source\": \"id tempor dolore irure\",\n \"decided_by_staff_id\": \"urn:uuid:c0c7c7de-8c85-a9f8-e834-75cef0d48cdc\",\n \"decided_at\": \"1993-04-16T22:52:42.851Z\",\n \"created_at\": \"1959-08-18T14:25:40.557Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"in nostrud quis\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7e7fd62-ed8b-5386-8e19-dbe25f8785f6", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "duplicate_flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "dismissed" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5045b8f3-602b-53d4-925d-b997661ffb5d", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "duplicate_flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "dismissed" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72f71636-2fd5-514b-8981-5bbcbdb95eb6", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "duplicate_flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "dismissed" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b91d092-82a0-5f27-bae7-6e77dbb80d67", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "duplicate_flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "dismissed" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0c3c2b4-a5c2-5eb4-8dc2-d531d0ab8b2f", "name": "Exact-match patient search by two or more identifiers. Identifiers in the body, never a URL.", "request": { "name": "Exact-match patient search by two or more identifiers. Identifiers in the body, never a URL.", "description": { "content": "Never a name-only or partial match; at least two identifiers of DIFFERENT kinds (email, phone, mrn) are required, so this cannot be used to iterate one field at a time. Capped at 5 results. \"No match\" and \"not permitted\" are the identical response — an empty `data` array, never a 404: the query itself already excludes anything the caller may not see. For an organization key, results are limited to patients LINKED through that connection — today this is moot in practice (patients:read is PHI, and the organization patient-data master switch ships false), but the route is built and tested as though it were open.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patients", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n {\n \"system\": \"phone\",\n \"value\": \"labore ea exercitation\"\n },\n {\n \"system\": \"mrn\",\n \"value\": \"Lorem\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4b3efbe6-8426-5bb7-a7f6-33eb7f182045", "name": "OK. An empty `data` array means no match, or the caller may not see the match — deliberately indistinguishable.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n {\n \"system\": \"phone\",\n \"value\": \"labore ea exercitation\"\n },\n {\n \"system\": \"mrn\",\n \"value\": \"Lorem\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"41535991-7895-4334-eaf0-86cca3810462\",\n \"first_name\": \"Lorem veniam\",\n \"last_name\": \"ullamco eiusmod in\",\n \"mrn\": \"ea labore est reprehenderi\",\n \"middle_name\": \"nisi magna\",\n \"preferred_name\": \"sint quis\",\n \"title\": \"eu officia mollit eiusmod\",\n \"suffix\": \"eu\",\n \"date_of_birth\": \"2019-06-09\",\n \"gender\": \"other\",\n \"marital_status\": \"null\",\n \"client_type\": \"minor\",\n \"client_status\": \"enim ipsum\",\n \"is_dependent\": false,\n \"email\": \"labo\",\n \"phone\": \"anim\",\n \"secondary_phone\": \"id\",\n \"country\": \"cupidatat dolor sunt\",\n \"nationality\": \"id laborum ad fugiat\",\n \"occupation\": \"velit pariatur ullamco quis in\",\n \"residential_address\": \"magna non veniam et deserunt\",\n \"work_address\": \"laborum deserunt\",\n \"city\": \"ex cupidatat\",\n \"state\": \"ipsum\",\n \"zip\": \"nulla ex mollit\",\n \"next_of_kin\": {\n \"name\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n }\n },\n \"national_id\": \"quis eu sunt\",\n \"preferred_language\": \"cillum vel\",\n \"referred_by\": \"magna d\",\n \"referral_source_id\": \"urn:uuid:cb547cbd-c294-f952-73fe-f8d4ab2c7e57\",\n \"employment\": {\n \"status\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n },\n \"is_waitlist\": true,\n \"billing\": {\n \"individual_type\": {\n \"value\": \"\"\n },\n \"group_type\": {\n \"value\": \"\"\n }\n },\n \"sponsor_id\": \"23e8f8de-23f7-9b96-b755-5ddb84f758c3\",\n \"allergies\": [\n \"Lorem magna elit\",\n \"mollit ut\"\n ],\n \"medical_history\": \"dolore voluptate ut veniam\",\n \"current_medications\": [\n \"laborum Excepteur eu\",\n \"occaecat\"\n ],\n \"chronic_conditions\": [\n \"id sit dolore\",\n \"in\"\n ],\n \"blood_type\": \"B+\",\n \"genotype\": \"SS\",\n \"family_history\": \"mollit non sint qui sed\",\n \"smoking_status\": \"adipisicing ut pariatur aliquip esse\",\n \"alcohol_use\": \"dolor in velit Lorem pariatur\",\n \"recreational_drug_use\": \"laborum adipisicing\",\n \"physical_activity\": \"cillum Excepteur enim ess\",\n \"living_arrangement\": \"eu cillum Lorem quis fugiat\",\n \"has_profile_image\": true,\n \"profile_image_path\": \"sunt reprehenderit non minim\",\n \"status\": \"null\",\n \"is_vip\": false,\n \"primary_location_id\": \"urn:uuid:e314bf87-4d1a-9cff-b94e-d62c1bd59b30\",\n \"portal_access_enabled\": false,\n \"admission_status\": \"in nisi Duis nulla\",\n \"couple\": {\n \"value\": \"\"\n },\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"guardians\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"notification_settings\": {\n \"value\": \"\"\n },\n \"created_at\": \"1995-03-16T05:51:18.689Z\",\n \"updated_at\": \"2011-04-10T11:27:38.671Z\"\n },\n {\n \"id\": \"urn:uuid:28ab9dbf-1a44-8736-acbc-34bc8747422d\",\n \"first_name\": \"consequat pariatur nisi ea ullamco\",\n \"last_name\": \"non dolor laboris\",\n \"mrn\": \"irure anim cillum enim\",\n \"middle_name\": \"ex occaecat laborum dolor minim\",\n \"preferred_name\": \"sit dolore proident i\",\n \"title\": \"adipisicing dolor\",\n \"suffix\": \"esse aliqua cillum ad\",\n \"date_of_birth\": \"1998-05-11\",\n \"gender\": \"null\",\n \"marital_status\": \"widowed\",\n \"client_type\": \"null\",\n \"client_status\": \"incididunt aliqua culpa commodo\",\n \"is_dependent\": false,\n \"email\": \"aute aliqua Duis\",\n \"phone\": \"ad cupidatat veniam deserunt\",\n \"secondary_phone\": \"ullamco esse \",\n \"country\": \"dolore anim in esse pariatur\",\n \"nationality\": \"occaecat ut sit\",\n \"occupation\": \"sint\",\n \"residential_address\": \"nostrud reprehenderit ea\",\n \"work_address\": \"ipsum culpa\",\n \"city\": \"incididunt labore Lorem eiusmod\",\n \"state\": \"et\",\n \"zip\": \"sed\",\n \"next_of_kin\": {\n \"name\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n }\n },\n \"national_id\": \"aute veniam\",\n \"preferred_language\": \"ut esse est in\",\n \"referred_by\": \"magna aliquip deserunt\",\n \"referral_source_id\": \"f2934a6f-9eb5-65cf-8a7d-40e1d6589980\",\n \"employment\": {\n \"status\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n },\n \"is_waitlist\": false,\n \"billing\": {\n \"individual_type\": {\n \"value\": \"\"\n },\n \"group_type\": {\n \"value\": \"\"\n }\n },\n \"sponsor_id\": \"61165db7-b625-6b6a-acc1-3de56e51d18a\",\n \"allergies\": [\n \"re\",\n \"sunt et consectetur sed\"\n ],\n \"medical_history\": \"ex ipsum\",\n \"current_medications\": [\n \"est Ut aliquip eu\",\n \"culpa\"\n ],\n \"chronic_conditions\": [\n \"occaecat molli\",\n \"Ut officia\"\n ],\n \"blood_type\": \"AB+\",\n \"genotype\": \"AA\",\n \"family_history\": \"Lorem\",\n \"smoking_status\": \"dolore proident tempor exercitation\",\n \"alcohol_use\": \"occaecat Excepteur aliqua quis\",\n \"recreational_drug_use\": \"enim ull\",\n \"physical_activity\": \"aliqua Lorem\",\n \"living_arrangement\": \"enim ipsum adipisicing exercitation\",\n \"has_profile_image\": true,\n \"profile_image_path\": \"et aliquip\",\n \"status\": \"prospect\",\n \"is_vip\": true,\n \"primary_location_id\": \"urn:uuid:1fcedc91-4ee5-f28c-d9a8-b06309f1a1a9\",\n \"portal_access_enabled\": true,\n \"admission_status\": \"sint exer\",\n \"couple\": {\n \"value\": \"\"\n },\n \"emails\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"phones\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"guardians\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"notification_settings\": {\n \"value\": \"\"\n },\n \"created_at\": \"1967-04-06T00:36:04.183Z\",\n \"updated_at\": \"1973-06-23T12:54:07.266Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6510cca1-e026-5ab5-aeba-2a72c9956556", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n {\n \"system\": \"phone\",\n \"value\": \"labore ea exercitation\"\n },\n {\n \"system\": \"mrn\",\n \"value\": \"Lorem\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca2a940d-f434-5446-90d7-56dea2a2bd57", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n {\n \"system\": \"phone\",\n \"value\": \"labore ea exercitation\"\n },\n {\n \"system\": \"mrn\",\n \"value\": \"Lorem\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ce7b86-2b77-59a8-85e5-26152ed7c68e", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n {\n \"system\": \"phone\",\n \"value\": \"labore ea exercitation\"\n },\n {\n \"system\": \"mrn\",\n \"value\": \"Lorem\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdbdf754-5be3-5f42-bf83-8859ade98b0b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patients", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n {\n \"system\": \"phone\",\n \"value\": \"labore ea exercitation\"\n },\n {\n \"system\": \"mrn\",\n \"value\": \"Lorem\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0897b642-f8e9-5816-a241-c734be7eabd3", "name": "Import up to 100 patients from a FHIR Bundle, NDJSON, or a JSON array. Nothing is written unless every row is valid.", "request": { "name": "Import up to 100 patients from a FHIR Bundle, NDJSON, or a JSON array. Nothing is written unless every row is valid.", "description": { "content": "The same import the app's Patients screen offers, for the clinic's OWN key. The file is checked in full before anything is written: every row goes through the same validation a real create does. If EVERY row is valid the import runs at once and the response is the finished job (`status: succeeded`). If ANY row fails, nothing is written and the response is the job with `status: needs_review` and a `row_errors` list — row number, field and reason for each, never the value that failed. Fix the file and send it again, or call `runValidPatientImportRows` to import only the rows that passed. A file with exactly the same content that has already been imported is refused `already_imported`, so retrying a timed-out call is safe; no Idempotency-Key is needed or read. An import contacts no patient and starts no automation. A possible duplicate is still created and counted in `flagged_duplicate`, for staff to review. Limits: 100 rows and 10 MiB, refused before any row is read. Needs `patients:write`, the API add-on and the accepted API data agreement. Only a clinic's own key may import — an organization connected to the clinic may not, whatever it was granted (`not_found`).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "797c8811-2f20-5385-adb8-24556113813f", "name": "The finished job — `succeeded`, `needs_review`, or `failed`.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:0a1e16d3-a7fb-80f6-d7b1-eb568f715cec\",\n \"status\": \"needs_review\",\n \"input_format\": \"fhir_bundle\",\n \"row_count\": 21728335,\n \"last_processed_row\": -66603565,\n \"counts\": {\n \"created\": -84510592,\n \"flagged_duplicate\": -13259092,\n \"skipped_already_imported\": -90667674,\n \"failed\": 34446585\n },\n \"row_errors\": [\n {\n \"row\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n }\n },\n {\n \"row\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"2020-04-17T01:29:54.413Z\",\n \"updated_at\": \"1962-08-12T06:26:34.559Z\",\n \"started_by\": \"session\",\n \"valid_only_run_at\": \"1974-05-07T06:50:27.398Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3502b180-8204-5590-94f6-78825fa7d24c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ef3484e-a959-5bb0-aa27-7f76017ad741", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be9180be-1169-55e6-824d-4e241f746b1c", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "802d205f-9335-560a-ade5-a603254d431a", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62409284-2d62-550f-93d0-5b99d8b0141c", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "480e41d6-272a-56a8-bf99-cbc6281d1c3f", "name": "The request body is larger than the route accepts (`payload_too_large` — 10 MiB for a patient import).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b889d2a-3769-5b32-8ec1-66d2e5b6ae94", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"format\": \"ndjson\",\n \"data\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d42cc76-0140-5a6d-ae46-c46ad1c54b3d", "name": "This clinic's import jobs, oldest first.", "request": { "name": "This clinic's import jobs, oldest first.", "description": { "content": "Job progress and outcome only — never a file, a patient, or a value that failed validation. Needs `patients:write`, like the rest of the import.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b3c81c1a-618f-5c03-9774-2b4d1e10b9b9", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:ef426783-3667-bf3c-898e-db0a1754cea5\",\n \"status\": \"succeeded\",\n \"input_format\": \"ndjson\",\n \"row_count\": 2111794,\n \"last_processed_row\": -98708437,\n \"counts\": {\n \"created\": -80463014,\n \"flagged_duplicate\": -41780909,\n \"skipped_already_imported\": -12919811,\n \"failed\": -87946461\n },\n \"row_errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"1994-12-20T21:06:49.790Z\",\n \"updated_at\": \"1992-11-15T10:56:00.846Z\",\n \"started_by\": \"key\",\n \"valid_only_run_at\": \"1951-05-11T03:43:37.314Z\"\n },\n {\n \"id\": \"urn:uuid:02697921-7ded-87ca-8afb-5dfd7fe190d9\",\n \"status\": \"failed\",\n \"input_format\": \"ndjson\",\n \"row_count\": 96537677,\n \"last_processed_row\": 95110023,\n \"counts\": {\n \"created\": -11336531,\n \"flagged_duplicate\": -23863625,\n \"skipped_already_imported\": 84115023,\n \"failed\": -68806869\n },\n \"row_errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"2025-11-10T10:27:09.838Z\",\n \"updated_at\": \"1994-10-06T13:58:02.906Z\",\n \"started_by\": \"session\",\n \"valid_only_run_at\": \"1980-09-01T03:22:34.539Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"enim dolor\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5075ac02-caea-527f-b2b6-0c158b71e71c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f9f02c9-360b-5b0e-8ac6-19b92c64e966", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce4f37f7-bbe0-53a5-8fd6-8f4dc90acbab", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "665a0339-c345-5b8a-98f4-1e0522a50127", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4857d29b-f384-5579-9a8f-d8e218baa964", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0f45a20-cb51-5ec9-955f-5faa2ea97eed", "name": "One import job.", "request": { "name": "One import job.", "description": { "content": "Absent, another clinic's, and not-permitted are one `not_found`.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patient-imports", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e754f38-9366-5708-9454-4c2669a93f8b", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:0a1e16d3-a7fb-80f6-d7b1-eb568f715cec\",\n \"status\": \"needs_review\",\n \"input_format\": \"fhir_bundle\",\n \"row_count\": 21728335,\n \"last_processed_row\": -66603565,\n \"counts\": {\n \"created\": -84510592,\n \"flagged_duplicate\": -13259092,\n \"skipped_already_imported\": -90667674,\n \"failed\": 34446585\n },\n \"row_errors\": [\n {\n \"row\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n }\n },\n {\n \"row\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"2020-04-17T01:29:54.413Z\",\n \"updated_at\": \"1962-08-12T06:26:34.559Z\",\n \"started_by\": \"session\",\n \"valid_only_run_at\": \"1974-05-07T06:50:27.398Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f97945ca-96cc-52bb-97e6-5d533799e54a", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54c11395-b183-541a-876d-5234231dac1e", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f89fca04-2cf4-56de-a3bc-c9bb5e340f50", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0bf647d-e32c-5f25-901a-cc6468364728", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c7bb999-b97d-52c2-9a24-a9f1d7a59511", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2aaaa5e8-01e4-5525-9207-ff94121f50c5", "name": "Import only the rows that passed, for a job waiting for review.", "request": { "name": "Import only the rows that passed, for a job waiting for review.", "description": { "content": "An explicit, recorded choice — the key that made it is stored on the job. Only a job in `needs_review` whose file is still held (files are deleted after 7 days) can be run this way; anything else is `invalid_status_transition` (409) or `file_expired` (410). Rows that failed stay in `row_errors` for reference and are not imported. The response is the finished job.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bd07c72e-9b09-5a5b-ad32-4d14be7532d0", "name": "The finished job.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:0a1e16d3-a7fb-80f6-d7b1-eb568f715cec\",\n \"status\": \"needs_review\",\n \"input_format\": \"fhir_bundle\",\n \"row_count\": 21728335,\n \"last_processed_row\": -66603565,\n \"counts\": {\n \"created\": -84510592,\n \"flagged_duplicate\": -13259092,\n \"skipped_already_imported\": -90667674,\n \"failed\": 34446585\n },\n \"row_errors\": [\n {\n \"row\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n }\n },\n {\n \"row\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"2020-04-17T01:29:54.413Z\",\n \"updated_at\": \"1962-08-12T06:26:34.559Z\",\n \"started_by\": \"session\",\n \"valid_only_run_at\": \"1974-05-07T06:50:27.398Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2ad0895-bf96-5386-8727-1e8672fd0dad", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f56adbf-73fc-58a3-9905-77adf92a47ad", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c76d050c-a234-549f-91c9-42e4c3762a21", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea1a517-6ac5-51a8-a7dd-5d1f79ab3df1", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b77ad95-6ac8-5cc4-9da3-8535c37446c4", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1034814-a977-5da3-b1a3-d67e6b0e7867", "name": "The thing asked about existed and is no longer held (`file_expired` — an import's uploaded file is deleted after 7 days).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5992d268-2a30-5d67-a2fe-92c40447e8bf", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "patient-imports", ":job_id", "run-valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "job_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f10bdccf-4867-55f5-9843-40a5954f34dd", "name": "Dispensing", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "05e9fb8b-4b6e-5513-b786-542e2bcb719c", "name": "A linked enrollee's own dispensing history — medicine, quantity, days supply, date. Never price.", "request": { "name": "A linked enrollee's own dispensing history — medicine, quantity, days supply, date. Never price.", "description": { "content": "patient_id is required. For an organization key, the enrollee must be linked through the connection, or this answers not_found. A clinic's own key may read its own customers' dispensing history under the same scope, with the add-on and agreement.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "dispensing", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cd03fe71-1e26-5bdc-bfdf-4220b2c972b4", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"4e6883c7-3cf4-97b2-737d-09c8bee53b14\",\n \"medicine\": {\n \"name\": {\n \"value\": \"\"\n },\n \"generic_name\": {\n \"value\": \"\"\n },\n \"brand_name\": {\n \"value\": \"\"\n },\n \"identifiers\": {\n \"value\": \"\"\n }\n },\n \"quantity\": 35325102.088972926,\n \"days_supply\": -6041220,\n \"dispensed_at\": \"2015-05-31T14:03:04.684Z\"\n },\n {\n \"id\": \"9966a2bf-06fe-e711-878f-1e350f3de1ec\",\n \"medicine\": {\n \"name\": {\n \"value\": \"\"\n },\n \"generic_name\": {\n \"value\": \"\"\n },\n \"brand_name\": {\n \"value\": \"\"\n },\n \"identifiers\": {\n \"value\": \"\"\n }\n },\n \"quantity\": -42371973.62817824,\n \"days_supply\": 82342656,\n \"dispensed_at\": \"2000-12-15T17:03:30.761Z\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"veniam Excepteur sint\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be09b7d6-f02b-5e76-a2ff-227a2088c277", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e91a97e6-8b90-5283-8f34-45cc81e045ad", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fff0d4b-10d3-5914-9db2-c343f6b2775d", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "230aeb45-09c7-586f-ab4e-1f8a0c9cc588", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc5953fa-b653-53fa-9230-521de4bbb44d", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f291fdf-a574-5d4c-95fe-1e064e1194ac", "name": "Refill/duplicate-dispensing flags for the caller's linked enrollees, in a date window.", "request": { "name": "Refill/duplicate-dispensing flags for the caller's linked enrollees, in a date window.", "description": { "content": "Each flag's rule, evidence, and the pharmacist's reason — never price, margin, staff identity beyond this, or any other customer of the pharmacy. Never references the \"possibly the same person\" mechanism — that is a prompt to look, never a finding, and never crosses the API boundary.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "dispensing", "flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "until", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "21e5a64e-e74a-5a31-ae64-627c7cb1baf5", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "until", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:16b20a4e-f320-c034-e2f7-4dcd9179e9d9\",\n \"patient_id\": \"urn:uuid:c21bc09a-cddd-b3a4-11ca-0560abf229db\",\n \"medicine\": {\n \"name\": {\n \"value\": \"\"\n },\n \"generic_name\": {\n \"value\": \"\"\n },\n \"brand_name\": {\n \"value\": \"\"\n },\n \"identifiers\": {\n \"value\": \"\"\n }\n },\n \"days_supply\": -81531504,\n \"date\": \"1971-11-25T09:01:49.813Z\",\n \"check_state\": \"shown_acknowledged\",\n \"flags\": [\n \"\",\n \"Duis\"\n ],\n \"evidence\": {},\n \"reason\": {\n \"code\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"urn:uuid:c29ea68d-0bd3-db8e-f123-ec7d866f93a8\",\n \"patient_id\": \"d5fa352f-d20f-2b23-c67e-b20617ae2ad2\",\n \"medicine\": {\n \"name\": {\n \"value\": \"\"\n },\n \"generic_name\": {\n \"value\": \"\"\n },\n \"brand_name\": {\n \"value\": \"\"\n },\n \"identifiers\": {\n \"value\": \"\"\n }\n },\n \"days_supply\": -29334140,\n \"date\": \"2024-10-08T11:29:00.921Z\",\n \"check_state\": \"shown_acknowledged\",\n \"flags\": [\n \"sunt\",\n \"id non nostrud nisi\"\n ],\n \"evidence\": {},\n \"reason\": {\n \"code\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"consequat in velit dolor\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7672199f-c4bd-53c8-b184-2267e22231cc", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "until", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "522b7c84-4845-541a-a7df-293a7a99f680", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "until", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4dc9842-0502-55f9-9758-f0e750aab441", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "until", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f330e9da-d494-52dc-8372-714773d8261a", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "dispensing", "flags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "until", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7118a3cf-a159-5b60-8f10-b80018d61c43", "name": "CRM", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "47ca0d3d-cd21-56b9-8c8d-7331836ea4bd", "name": "Pipelines and their stages — non-PHI reference data, for filtering or creating contacts.", "request": { "name": "Pipelines and their stages — non-PHI reference data, for filtering or creating contacts.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "crm", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "88942834-e99a-5a92-8c1f-87789ca37d7f", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"0aaf7807-a031-e339-8302-378dac841c57\",\n \"name\": \"nulla ut in et\",\n \"is_default\": false,\n \"sort_order\": -99389901,\n \"created_at\": \"1965-08-29T14:18:54.743Z\",\n \"updated_at\": \"1949-07-25T17:37:58.627Z\",\n \"stages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"5d3a9d62-ff06-38f4-5af2-4af2e80af8d9\",\n \"name\": \"ullamco nulla pariatur\",\n \"is_default\": true,\n \"sort_order\": 43116897,\n \"created_at\": \"1959-09-07T16:40:38.822Z\",\n \"updated_at\": \"1955-08-08T13:31:51.246Z\",\n \"stages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ab24886-245e-5b83-911d-d1d0e8dc2d42", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38ed3064-cc4c-5dd6-ac64-d7db62aba012", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdc66512-afc5-5f9a-b38f-628c082972c0", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5575b902-6452-5035-bfd4-205b04a600f0", "name": "List this clinic's CRM contacts.", "request": { "name": "List this clinic's CRM contacts.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "stage_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "365fdc1a-d898-5ace-91f1-4c74a44be681", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "stage_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"f99dc9f4-2a01-9a45-a524-275b7f5df9e3\",\n \"owner_staff_id\": \"c1a7329a-b731-7126-cae4-a0505dad5abd\",\n \"record_type\": \"referral\",\n \"first_name\": \"eiusmod eu tempor velit\",\n \"last_name\": \"dolore nisi commodo sed\",\n \"email\": \"sunt quis pariatur nisi\",\n \"phone\": \"Excepteur aliqua pariatur sunt\",\n \"company\": \"elit dol\",\n \"lifecycle_stage\": \"lost\",\n \"pipeline_id\": \"c753facb-aa1f-3568-fe12-a7ffb29a548f\",\n \"stage_id\": \"urn:uuid:3c21ead6-1f25-82f4-48e1-46896d6caa54\",\n \"status\": \"veniam laboris dolore eiusmod\",\n \"source\": \"dolore consectetur exercitation fugiat occaecat\",\n \"referral_source_id\": \"4f465f35-d2bb-5a98-bb6a-374885f57e19\",\n \"referred_by_contact_id\": \"urn:uuid:a7f775e5-9c56-c72a-f92f-07cc15f075a0\",\n \"interest\": \"mollit occaecat ea aute\",\n \"desired_service_id\": \"urn:uuid:87597a78-5577-99f1-299b-87741dff1968\",\n \"desired_provider_id\": \"41804ac0-d97d-8598-3ad7-995a949e15a7\",\n \"estimated_value_cents\": -89204035,\n \"currency\": \"qui\",\n \"priority\": \"low\",\n \"score\": 94913574,\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"consent_at\": \"1993-10-01T17:39:48.245Z\",\n \"consent_source\": \"magna aliqua\",\n \"do_not_contact\": false,\n \"unsubscribed_at\": \"2001-10-17T16:29:21.715Z\",\n \"tags\": [\n \"ea laborum mollit tempor ex\",\n \"nostrud in adipisicing quis culpa\"\n ],\n \"custom_fields\": {},\n \"converted_patient_id\": \"urn:uuid:7c8996b4-baab-3507-fcdb-9e567cd2f76c\",\n \"converted_at\": \"1982-01-12T17:48:45.456Z\",\n \"lost_reason\": \"f\",\n \"last_activity_at\": \"2018-10-01T14:02:47.954Z\",\n \"next_task_at\": \"1957-12-17T12:12:04.122Z\",\n \"created_at\": \"2008-10-03T21:08:13.243Z\",\n \"updated_at\": \"2018-04-05T00:52:33.648Z\"\n },\n {\n \"id\": \"urn:uuid:a536c98d-1880-74e5-113c-d66c3c3e5064\",\n \"owner_staff_id\": \"urn:uuid:f15b2931-13b1-9243-d326-87c0e4b601e3\",\n \"record_type\": \"lead\",\n \"first_name\": \"est labore dolor cup\",\n \"last_name\": \"nostrud proident\",\n \"email\": \"aute esse \",\n \"phone\": \"sint dolor\",\n \"company\": \"aute velit magna Lorem\",\n \"lifecycle_stage\": \"customer\",\n \"pipeline_id\": \"f1ac0100-7cd6-c745-f325-713c4885f603\",\n \"stage_id\": \"665e0cda-3457-8c87-0c69-e500e09f229a\",\n \"status\": \"dolore\",\n \"source\": \"Lorem\",\n \"referral_source_id\": \"7a04fdbd-eeb4-3603-981c-d45bb256cf62\",\n \"referred_by_contact_id\": \"urn:uuid:8a9bb617-f4f8-1594-b159-08d9a9039ffa\",\n \"interest\": \"laborum\",\n \"desired_service_id\": \"urn:uuid:b2794185-6dc1-d91b-1a88-d69fa7f1c7cd\",\n \"desired_provider_id\": \"urn:uuid:7edd90ac-3c04-be0f-ba15-f86ad482fa69\",\n \"estimated_value_cents\": -89314741,\n \"currency\": \"incididunt in\",\n \"priority\": \"normal\",\n \"score\": -14014272,\n \"marketing_opt_in\": false,\n \"sms_opt_in\": false,\n \"consent_at\": \"1950-06-06T03:22:41.761Z\",\n \"consent_source\": \"aute pariatur in dolore\",\n \"do_not_contact\": false,\n \"unsubscribed_at\": \"1956-09-04T09:13:43.600Z\",\n \"tags\": [\n \"dolor in\",\n \"sint anim\"\n ],\n \"custom_fields\": {},\n \"converted_patient_id\": \"urn:uuid:2509ca52-8392-0576-a442-479d90707a91\",\n \"converted_at\": \"1959-09-13T05:00:23.930Z\",\n \"lost_reason\": \"consectet\",\n \"last_activity_at\": \"2001-09-07T20:50:41.322Z\",\n \"next_task_at\": \"1957-12-30T02:31:41.792Z\",\n \"created_at\": \"1952-07-17T02:46:33.921Z\",\n \"updated_at\": \"1984-11-11T01:29:04.160Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"veniam Ut sint adipisicing reprehenderit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c423227c-908e-5fc1-88bf-f5747a71316a", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "stage_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd210fbf-fd2c-57d6-907a-a8960835e445", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "stage_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e6d992b-c3f6-56b0-b4bf-2ea092087407", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "stage_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8677ffc8-4687-507f-a9a6-7420e78ef408", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "stage_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48d050d0-c12e-5d8e-8497-78ca8b22f0f2", "name": "Create a CRM contact. Never starts outreach.", "request": { "name": "Create a CRM contact. Never starts outreach.", "description": { "content": "Mirrors db/actions/crm.ts createCrmContact's own validation, defaults, and default-pipeline/stage resolution. is_email_domain_blocked is checked server-side on any email. Both crm_contacts outreach triggers (an Agent Studio automation, a marketing-journey enrollment) are suppressed unconditionally for this write.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"owner_staff_id\": \"b36960e6-63c3-9350-2e41-daf5ab110616\",\n \"record_type\": \"contact\",\n \"first_name\": \"veniam minim et id Duis\",\n \"last_name\": \"ea veniam aute\",\n \"email\": \"consectetur aliqua\",\n \"phone\": \"enim dolor pariatur quis cupidatat\",\n \"company\": \"ad sed nostrud velit\",\n \"lifecycle_stage\": \"lead\",\n \"pipeline_id\": \"26f1757d-9768-732d-f2b7-dfc44bba08a5\",\n \"stage_id\": \"urn:uuid:315bdfb3-7c32-baf9-4493-c85a1fe91aac\",\n \"source\": \"nulla consectetur\",\n \"referral_source_id\": \"urn:uuid:effe20e4-7ed2-96f5-6b5b-7a3fe7607909\",\n \"interest\": \"ipsum ut\",\n \"desired_service_id\": \"87d8dfa7-023e-c22c-a090-df24074162ae\",\n \"desired_provider_id\": \"urn:uuid:73088e50-c32c-4035-312e-07413a528c13\",\n \"estimated_value_cents\": 41249521,\n \"priority\": \"low\",\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"tags\": [\n \"laboris occaecat\",\n \"sint Excepteur in\"\n ],\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "43c92ad7-e342-519e-9696-8afbc4bb80c0", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"owner_staff_id\": \"urn:uuid:df9279b0-1d42-33d5-1d76-f911e0bc2266\",\n \"record_type\": \"referral\",\n \"first_name\": \"anim Ut aliqua\",\n \"last_name\": \"ullamco exercitation Ut aliquip\",\n \"email\": \"Ut\",\n \"phone\": \"dolore et nisi\",\n \"company\": \"aliqua\",\n \"lifecycle_stage\": \"inquiry\",\n \"pipeline_id\": \"f889bbbf-f56f-5947-9a23-123cd3ac9b38\",\n \"stage_id\": \"551aecdd-c821-cbae-5d8e-12c4d2e268f5\",\n \"source\": \"ad laborum\",\n \"referral_source_id\": \"urn:uuid:9522f2c1-02ff-a72b-c072-847d97c28f08\",\n \"interest\": \"pariatur\",\n \"desired_service_id\": \"urn:uuid:2e798099-6d48-e687-6d4b-be3a455f5c30\",\n \"desired_provider_id\": \"urn:uuid:373d75e0-c94b-0d96-fdaf-8698c752a804\",\n \"estimated_value_cents\": -25673628,\n \"priority\": \"normal\",\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"tags\": [\n \"exercitation mollit ex\",\n \"ex Ex\"\n ],\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"2e8f4e21-704c-7658-2df4-2969940b7fa9\",\n \"owner_staff_id\": \"urn:uuid:ac4d67d1-2b0d-e784-98c4-f7f580349711\",\n \"record_type\": \"lead\",\n \"first_name\": \"nulla laborum eu\",\n \"last_name\": \"fugiat n\",\n \"email\": \"sed voluptate\",\n \"phone\": \"et commodo velit\",\n \"company\": \"enim magna\",\n \"lifecycle_stage\": \"prospect\",\n \"pipeline_id\": \"urn:uuid:046a4893-676d-0fbc-f8f2-245728f76e5c\",\n \"stage_id\": \"604d9bde-2a07-e75c-5261-ffc38a77c75b\",\n \"status\": \"ipsum in cillum f\",\n \"source\": \"cillum ipsum Duis dolore irure\",\n \"referral_source_id\": \"d77bce00-a889-7eb2-88d2-b22fd94a06f0\",\n \"referred_by_contact_id\": \"a5f3afce-c0b9-4d34-3419-5a07e9524a07\",\n \"interest\": \"enim minim commodo in\",\n \"desired_service_id\": \"urn:uuid:e5a567ed-415d-0ba7-6289-4acabbe68127\",\n \"desired_provider_id\": \"f72458e7-84dd-fa54-ae02-710c5f60faae\",\n \"estimated_value_cents\": -600463,\n \"currency\": \"sit est nisi\",\n \"priority\": \"normal\",\n \"score\": 41901193,\n \"marketing_opt_in\": true,\n \"sms_opt_in\": true,\n \"consent_at\": \"1957-06-10T11:21:46.043Z\",\n \"consent_source\": \"est tempor officia sit in\",\n \"do_not_contact\": true,\n \"unsubscribed_at\": \"1992-06-10T21:47:23.301Z\",\n \"tags\": [\n \"am\",\n \"in magna\"\n ],\n \"custom_fields\": {},\n \"converted_patient_id\": \"urn:uuid:5f0e53b9-0001-6886-7ab6-cb6419e63a5d\",\n \"converted_at\": \"2011-04-03T16:32:18.685Z\",\n \"lost_reason\": \"magna sunt\",\n \"last_activity_at\": \"1962-10-07T13:18:00.822Z\",\n \"next_task_at\": \"1960-11-07T17:38:58.886Z\",\n \"created_at\": \"1983-08-23T16:50:51.542Z\",\n \"updated_at\": \"2018-09-17T07:10:32.149Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a5ac524-3398-5a68-8346-e1e28e851cc7", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"owner_staff_id\": \"urn:uuid:df9279b0-1d42-33d5-1d76-f911e0bc2266\",\n \"record_type\": \"referral\",\n \"first_name\": \"anim Ut aliqua\",\n \"last_name\": \"ullamco exercitation Ut aliquip\",\n \"email\": \"Ut\",\n \"phone\": \"dolore et nisi\",\n \"company\": \"aliqua\",\n \"lifecycle_stage\": \"inquiry\",\n \"pipeline_id\": \"f889bbbf-f56f-5947-9a23-123cd3ac9b38\",\n \"stage_id\": \"551aecdd-c821-cbae-5d8e-12c4d2e268f5\",\n \"source\": \"ad laborum\",\n \"referral_source_id\": \"urn:uuid:9522f2c1-02ff-a72b-c072-847d97c28f08\",\n \"interest\": \"pariatur\",\n \"desired_service_id\": \"urn:uuid:2e798099-6d48-e687-6d4b-be3a455f5c30\",\n \"desired_provider_id\": \"urn:uuid:373d75e0-c94b-0d96-fdaf-8698c752a804\",\n \"estimated_value_cents\": -25673628,\n \"priority\": \"normal\",\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"tags\": [\n \"exercitation mollit ex\",\n \"ex Ex\"\n ],\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a34347ac-3c8b-5b8b-8f7c-3281a72a9f34", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"owner_staff_id\": \"urn:uuid:df9279b0-1d42-33d5-1d76-f911e0bc2266\",\n \"record_type\": \"referral\",\n \"first_name\": \"anim Ut aliqua\",\n \"last_name\": \"ullamco exercitation Ut aliquip\",\n \"email\": \"Ut\",\n \"phone\": \"dolore et nisi\",\n \"company\": \"aliqua\",\n \"lifecycle_stage\": \"inquiry\",\n \"pipeline_id\": \"f889bbbf-f56f-5947-9a23-123cd3ac9b38\",\n \"stage_id\": \"551aecdd-c821-cbae-5d8e-12c4d2e268f5\",\n \"source\": \"ad laborum\",\n \"referral_source_id\": \"urn:uuid:9522f2c1-02ff-a72b-c072-847d97c28f08\",\n \"interest\": \"pariatur\",\n \"desired_service_id\": \"urn:uuid:2e798099-6d48-e687-6d4b-be3a455f5c30\",\n \"desired_provider_id\": \"urn:uuid:373d75e0-c94b-0d96-fdaf-8698c752a804\",\n \"estimated_value_cents\": -25673628,\n \"priority\": \"normal\",\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"tags\": [\n \"exercitation mollit ex\",\n \"ex Ex\"\n ],\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe74a6a-1903-538a-a4ae-4cef07a33f1d", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"owner_staff_id\": \"urn:uuid:df9279b0-1d42-33d5-1d76-f911e0bc2266\",\n \"record_type\": \"referral\",\n \"first_name\": \"anim Ut aliqua\",\n \"last_name\": \"ullamco exercitation Ut aliquip\",\n \"email\": \"Ut\",\n \"phone\": \"dolore et nisi\",\n \"company\": \"aliqua\",\n \"lifecycle_stage\": \"inquiry\",\n \"pipeline_id\": \"f889bbbf-f56f-5947-9a23-123cd3ac9b38\",\n \"stage_id\": \"551aecdd-c821-cbae-5d8e-12c4d2e268f5\",\n \"source\": \"ad laborum\",\n \"referral_source_id\": \"urn:uuid:9522f2c1-02ff-a72b-c072-847d97c28f08\",\n \"interest\": \"pariatur\",\n \"desired_service_id\": \"urn:uuid:2e798099-6d48-e687-6d4b-be3a455f5c30\",\n \"desired_provider_id\": \"urn:uuid:373d75e0-c94b-0d96-fdaf-8698c752a804\",\n \"estimated_value_cents\": -25673628,\n \"priority\": \"normal\",\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"tags\": [\n \"exercitation mollit ex\",\n \"ex Ex\"\n ],\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f85d9ec1-6ba8-5d69-af9d-d954753a5202", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"owner_staff_id\": \"urn:uuid:df9279b0-1d42-33d5-1d76-f911e0bc2266\",\n \"record_type\": \"referral\",\n \"first_name\": \"anim Ut aliqua\",\n \"last_name\": \"ullamco exercitation Ut aliquip\",\n \"email\": \"Ut\",\n \"phone\": \"dolore et nisi\",\n \"company\": \"aliqua\",\n \"lifecycle_stage\": \"inquiry\",\n \"pipeline_id\": \"f889bbbf-f56f-5947-9a23-123cd3ac9b38\",\n \"stage_id\": \"551aecdd-c821-cbae-5d8e-12c4d2e268f5\",\n \"source\": \"ad laborum\",\n \"referral_source_id\": \"urn:uuid:9522f2c1-02ff-a72b-c072-847d97c28f08\",\n \"interest\": \"pariatur\",\n \"desired_service_id\": \"urn:uuid:2e798099-6d48-e687-6d4b-be3a455f5c30\",\n \"desired_provider_id\": \"urn:uuid:373d75e0-c94b-0d96-fdaf-8698c752a804\",\n \"estimated_value_cents\": -25673628,\n \"priority\": \"normal\",\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"tags\": [\n \"exercitation mollit ex\",\n \"ex Ex\"\n ],\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34e8e1b2-a8dd-5e6e-b5c4-e131cf0b445e", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"owner_staff_id\": \"urn:uuid:df9279b0-1d42-33d5-1d76-f911e0bc2266\",\n \"record_type\": \"referral\",\n \"first_name\": \"anim Ut aliqua\",\n \"last_name\": \"ullamco exercitation Ut aliquip\",\n \"email\": \"Ut\",\n \"phone\": \"dolore et nisi\",\n \"company\": \"aliqua\",\n \"lifecycle_stage\": \"inquiry\",\n \"pipeline_id\": \"f889bbbf-f56f-5947-9a23-123cd3ac9b38\",\n \"stage_id\": \"551aecdd-c821-cbae-5d8e-12c4d2e268f5\",\n \"source\": \"ad laborum\",\n \"referral_source_id\": \"urn:uuid:9522f2c1-02ff-a72b-c072-847d97c28f08\",\n \"interest\": \"pariatur\",\n \"desired_service_id\": \"urn:uuid:2e798099-6d48-e687-6d4b-be3a455f5c30\",\n \"desired_provider_id\": \"urn:uuid:373d75e0-c94b-0d96-fdaf-8698c752a804\",\n \"estimated_value_cents\": -25673628,\n \"priority\": \"normal\",\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true,\n \"tags\": [\n \"exercitation mollit ex\",\n \"ex Ex\"\n ],\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca2f4d98-3c1a-57b2-a5d5-7816091a7897", "name": "Exact-match contact search by email or phone. Identifiers in the body, never a URL.", "request": { "name": "Exact-match contact search by email or phone. Identifiers in the body, never a URL.", "description": { "content": "Never a partial or name match. Capped at 25 results (API6).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "crm", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"Lorem\",\n \"phone\": \"sunt\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0106159-d79c-5afd-bf7f-c8f0937f54e7", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"Lorem\",\n \"phone\": \"sunt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"614ff0af-2ca0-c9f3-95e0-bded15940cf1\",\n \"owner_staff_id\": \"urn:uuid:cb8e8e9e-1bfb-e655-8ab7-704460b2db9e\",\n \"record_type\": \"prospect\",\n \"first_name\": \"do consequat veniam pariatur\",\n \"last_name\": \"eiusmod sunt\",\n \"email\": \"dolor dolore dolor est\",\n \"phone\": \"labore veniam\",\n \"company\": \"anim in laborum\",\n \"lifecycle_stage\": \"lost\",\n \"pipeline_id\": \"6498182f-4df2-7147-44be-e793d3785db1\",\n \"stage_id\": \"urn:uuid:4d706fca-e09d-80c3-7b6b-203f524a0c73\",\n \"status\": \"est proident ut\",\n \"source\": \"n\",\n \"referral_source_id\": \"urn:uuid:3c9b0d83-5dfe-8c01-b60e-798021ce39c9\",\n \"referred_by_contact_id\": \"71cc0622-6ab9-bfbf-4814-310d60272976\",\n \"interest\": \"in ea nulla proident et\",\n \"desired_service_id\": \"59fe34d8-6cee-e679-9c5d-888fc8790cf0\",\n \"desired_provider_id\": \"urn:uuid:616ea0c3-62de-020c-4396-cf30af665ab5\",\n \"estimated_value_cents\": 29322004,\n \"currency\": \"ut nostrud\",\n \"priority\": \"null\",\n \"score\": 67886015,\n \"marketing_opt_in\": true,\n \"sms_opt_in\": true,\n \"consent_at\": \"2024-02-04T23:32:00.116Z\",\n \"consent_source\": \"do deserunt magna ea pariatur\",\n \"do_not_contact\": true,\n \"unsubscribed_at\": \"2005-07-23T16:48:35.779Z\",\n \"tags\": [\n \"dolor do pariatur\",\n \"nostrud aliqua elit eu deserunt\"\n ],\n \"custom_fields\": {},\n \"converted_patient_id\": \"urn:uuid:237d8637-5c47-dc8a-9f08-968f8e132f83\",\n \"converted_at\": \"1967-03-27T08:46:31.196Z\",\n \"lost_reason\": \"culpa esse id qui\",\n \"last_activity_at\": \"2006-03-07T10:30:00.847Z\",\n \"next_task_at\": \"2019-04-16T07:35:54.765Z\",\n \"created_at\": \"2016-02-20T09:22:52.323Z\",\n \"updated_at\": \"1987-02-19T14:28:43.992Z\"\n },\n {\n \"id\": \"urn:uuid:e3aa2843-38a5-2d1d-2eef-f29395e41917\",\n \"owner_staff_id\": \"urn:uuid:21ecb39e-7727-cc41-e18d-e21744d1582f\",\n \"record_type\": \"null\",\n \"first_name\": \"nostrud adipisicing ea incididunt\",\n \"last_name\": \"Duis eiusmod aliquip aute aliqua\",\n \"email\": \"culpa in velit\",\n \"phone\": \"amet id\",\n \"company\": \"nostrud Ut\",\n \"lifecycle_stage\": \"lead\",\n \"pipeline_id\": \"21fbf52f-f430-28d9-f46f-0dab9414360e\",\n \"stage_id\": \"3f79ac58-7399-be70-a26a-5587d62fbef3\",\n \"status\": \"dolore eiusmod cillum ea officia\",\n \"source\": \"enim\",\n \"referral_source_id\": \"urn:uuid:067dfa61-0360-1b5c-3a31-3cd0f412483a\",\n \"referred_by_contact_id\": \"urn:uuid:db54373c-ba44-5c93-1272-4f2ca25e353e\",\n \"interest\": \"consequat ad ut dolor\",\n \"desired_service_id\": \"83dd0088-3149-3ca3-9df9-ca5663c3584a\",\n \"desired_provider_id\": \"urn:uuid:b6ce72c1-3437-df77-2f96-e201ed7c5e80\",\n \"estimated_value_cents\": 52307816,\n \"currency\": \"ipsum qu\",\n \"priority\": \"normal\",\n \"score\": 4760029,\n \"marketing_opt_in\": true,\n \"sms_opt_in\": true,\n \"consent_at\": \"1968-05-13T08:55:11.922Z\",\n \"consent_source\": \"laborum pariatur dolore\",\n \"do_not_contact\": false,\n \"unsubscribed_at\": \"1973-11-14T09:52:16.258Z\",\n \"tags\": [\n \"proident aliqua\",\n \"mollit et occaecat\"\n ],\n \"custom_fields\": {},\n \"converted_patient_id\": \"urn:uuid:78e4196a-cc14-45ff-36e4-c77989dbc4ae\",\n \"converted_at\": \"2024-10-03T10:05:42.350Z\",\n \"lost_reason\": \"ea enim\",\n \"last_activity_at\": \"2013-09-25T14:47:19.857Z\",\n \"next_task_at\": \"1963-12-20T11:52:40.745Z\",\n \"created_at\": \"1988-05-07T07:46:30.163Z\",\n \"updated_at\": \"1952-11-21T02:42:31.689Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09bc66a7-58c4-5058-a38b-4fd67193e994", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"Lorem\",\n \"phone\": \"sunt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4c8106d-35c9-5605-b3c3-8a3b0f480b26", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"Lorem\",\n \"phone\": \"sunt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89bc336d-1261-5270-91a4-bc2b6083a9b0", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"Lorem\",\n \"phone\": \"sunt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9edb233-fbba-5fd0-81ad-12f75822092f", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"Lorem\",\n \"phone\": \"sunt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa498a00-4426-5049-8984-830fb4f58f89", "name": "Get one CRM contact by id.", "request": { "name": "Get one CRM contact by id.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2fde434e-74a8-5dcf-9498-beae2892e3b2", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"2e8f4e21-704c-7658-2df4-2969940b7fa9\",\n \"owner_staff_id\": \"urn:uuid:ac4d67d1-2b0d-e784-98c4-f7f580349711\",\n \"record_type\": \"lead\",\n \"first_name\": \"nulla laborum eu\",\n \"last_name\": \"fugiat n\",\n \"email\": \"sed voluptate\",\n \"phone\": \"et commodo velit\",\n \"company\": \"enim magna\",\n \"lifecycle_stage\": \"prospect\",\n \"pipeline_id\": \"urn:uuid:046a4893-676d-0fbc-f8f2-245728f76e5c\",\n \"stage_id\": \"604d9bde-2a07-e75c-5261-ffc38a77c75b\",\n \"status\": \"ipsum in cillum f\",\n \"source\": \"cillum ipsum Duis dolore irure\",\n \"referral_source_id\": \"d77bce00-a889-7eb2-88d2-b22fd94a06f0\",\n \"referred_by_contact_id\": \"a5f3afce-c0b9-4d34-3419-5a07e9524a07\",\n \"interest\": \"enim minim commodo in\",\n \"desired_service_id\": \"urn:uuid:e5a567ed-415d-0ba7-6289-4acabbe68127\",\n \"desired_provider_id\": \"f72458e7-84dd-fa54-ae02-710c5f60faae\",\n \"estimated_value_cents\": -600463,\n \"currency\": \"sit est nisi\",\n \"priority\": \"normal\",\n \"score\": 41901193,\n \"marketing_opt_in\": true,\n \"sms_opt_in\": true,\n \"consent_at\": \"1957-06-10T11:21:46.043Z\",\n \"consent_source\": \"est tempor officia sit in\",\n \"do_not_contact\": true,\n \"unsubscribed_at\": \"1992-06-10T21:47:23.301Z\",\n \"tags\": [\n \"am\",\n \"in magna\"\n ],\n \"custom_fields\": {},\n \"converted_patient_id\": \"urn:uuid:5f0e53b9-0001-6886-7ab6-cb6419e63a5d\",\n \"converted_at\": \"2011-04-03T16:32:18.685Z\",\n \"lost_reason\": \"magna sunt\",\n \"last_activity_at\": \"1962-10-07T13:18:00.822Z\",\n \"next_task_at\": \"1960-11-07T17:38:58.886Z\",\n \"created_at\": \"1983-08-23T16:50:51.542Z\",\n \"updated_at\": \"2018-09-17T07:10:32.149Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5306121c-0065-553a-aa13-acf947d7fc1b", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85cff538-ed39-5dcd-a4df-596cf62511f6", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "450331e5-c0da-53e2-aa08-adab5f51cf88", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e02daf4e-c4fe-5ddb-b625-a7d0b1a70a06", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b42acd3a-17f7-5a02-93e1-8c259e1c773f", "name": "Update a CRM contact. Absent fields are unchanged; JSON null clears a nullable field.", "request": { "name": "Update a CRM contact. Absent fields are unchanged; JSON null clears a nullable field.", "description": { "content": "status/score/do_not_contact/unsubscribed_at/converted_patient_id/ converted_at/lost_reason are never writable here.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"record_type\": \"contact\",\n \"first_name\": \"reprehenderit veniam\",\n \"last_name\": \"exercitation Ut sint veniam ull\",\n \"email\": \"fugiat cillum minim\",\n \"phone\": \"commodo \",\n \"company\": \"do\",\n \"lifecycle_stage\": \"inquiry\",\n \"pipeline_id\": \"urn:uuid:32a7b6f8-2df4-d12d-dea6-be8e938ce282\",\n \"stage_id\": \"urn:uuid:d3f3a603-05b0-50a7-6aa8-20d4a8e22bcd\",\n \"source\": \"cillum quis dolor\",\n \"owner_staff_id\": \"e400668a-ee43-76f8-9fe5-eded67167b1c\",\n \"referral_source_id\": \"2d9e65db-56ab-0f80-8270-558440c8ed2b\",\n \"interest\": \"dolore aliquip\",\n \"desired_service_id\": \"urn:uuid:f3df19c4-8db4-dd1e-7ff2-776bd6d12255\",\n \"desired_provider_id\": \"b0450fe3-30a4-026a-f61c-b1c0d920c03f\",\n \"estimated_value_cents\": 97832528,\n \"priority\": \"high\",\n \"tags\": [\n \"fugiat magna nostrud mollit\",\n \"mollit Ut\"\n ],\n \"custom_fields\": {},\n \"marketing_opt_in\": false,\n \"sms_opt_in\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e704989d-0562-56e9-8c8b-a14da19670c7", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"record_type\": \"prospect\",\n \"first_name\": \"id occaeca\",\n \"last_name\": \"incididunt eiusmod aliquip mollit\",\n \"email\": \"sunt minim in cillum\",\n \"phone\": \"commodo aute fugiat\",\n \"company\": \"nisi amet consequat et\",\n \"lifecycle_stage\": \"waitlist\",\n \"pipeline_id\": \"cf0f9d8f-7697-f6a9-a007-df051976c363\",\n \"stage_id\": \"9cb92db0-2bff-f05d-e2fe-957cb1cccd3c\",\n \"source\": \"ullamco officia cillum est\",\n \"owner_staff_id\": \"urn:uuid:53489664-50aa-8a8c-4364-00b9702d5718\",\n \"referral_source_id\": \"urn:uuid:3d3fe517-26df-0529-d7b0-13f5aa11d72a\",\n \"interest\": \"culpa sed est aute officia\",\n \"desired_service_id\": \"b766e715-c46b-4ee9-2cb5-14587ab21692\",\n \"desired_provider_id\": \"urn:uuid:195e77f3-799a-a314-bbf4-d52b8db30d5b\",\n \"estimated_value_cents\": 85621970,\n \"priority\": \"normal\",\n \"tags\": [\n \"con\",\n \"su\"\n ],\n \"custom_fields\": {},\n \"marketing_opt_in\": true,\n \"sms_opt_in\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"2e8f4e21-704c-7658-2df4-2969940b7fa9\",\n \"owner_staff_id\": \"urn:uuid:ac4d67d1-2b0d-e784-98c4-f7f580349711\",\n \"record_type\": \"lead\",\n \"first_name\": \"nulla laborum eu\",\n \"last_name\": \"fugiat n\",\n \"email\": \"sed voluptate\",\n \"phone\": \"et commodo velit\",\n \"company\": \"enim magna\",\n \"lifecycle_stage\": \"prospect\",\n \"pipeline_id\": \"urn:uuid:046a4893-676d-0fbc-f8f2-245728f76e5c\",\n \"stage_id\": \"604d9bde-2a07-e75c-5261-ffc38a77c75b\",\n \"status\": \"ipsum in cillum f\",\n \"source\": \"cillum ipsum Duis dolore irure\",\n \"referral_source_id\": \"d77bce00-a889-7eb2-88d2-b22fd94a06f0\",\n \"referred_by_contact_id\": \"a5f3afce-c0b9-4d34-3419-5a07e9524a07\",\n \"interest\": \"enim minim commodo in\",\n \"desired_service_id\": \"urn:uuid:e5a567ed-415d-0ba7-6289-4acabbe68127\",\n \"desired_provider_id\": \"f72458e7-84dd-fa54-ae02-710c5f60faae\",\n \"estimated_value_cents\": -600463,\n \"currency\": \"sit est nisi\",\n \"priority\": \"normal\",\n \"score\": 41901193,\n \"marketing_opt_in\": true,\n \"sms_opt_in\": true,\n \"consent_at\": \"1957-06-10T11:21:46.043Z\",\n \"consent_source\": \"est tempor officia sit in\",\n \"do_not_contact\": true,\n \"unsubscribed_at\": \"1992-06-10T21:47:23.301Z\",\n \"tags\": [\n \"am\",\n \"in magna\"\n ],\n \"custom_fields\": {},\n \"converted_patient_id\": \"urn:uuid:5f0e53b9-0001-6886-7ab6-cb6419e63a5d\",\n \"converted_at\": \"2011-04-03T16:32:18.685Z\",\n \"lost_reason\": \"magna sunt\",\n \"last_activity_at\": \"1962-10-07T13:18:00.822Z\",\n \"next_task_at\": \"1960-11-07T17:38:58.886Z\",\n \"created_at\": \"1983-08-23T16:50:51.542Z\",\n \"updated_at\": \"2018-09-17T07:10:32.149Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0029658-8a95-5ba3-a1a2-ca9add17baf2", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"record_type\": \"prospect\",\n \"first_name\": \"id occaeca\",\n \"last_name\": \"incididunt eiusmod aliquip mollit\",\n \"email\": \"sunt minim in cillum\",\n \"phone\": \"commodo aute fugiat\",\n \"company\": \"nisi amet consequat et\",\n \"lifecycle_stage\": \"waitlist\",\n \"pipeline_id\": \"cf0f9d8f-7697-f6a9-a007-df051976c363\",\n \"stage_id\": \"9cb92db0-2bff-f05d-e2fe-957cb1cccd3c\",\n \"source\": \"ullamco officia cillum est\",\n \"owner_staff_id\": \"urn:uuid:53489664-50aa-8a8c-4364-00b9702d5718\",\n \"referral_source_id\": \"urn:uuid:3d3fe517-26df-0529-d7b0-13f5aa11d72a\",\n \"interest\": \"culpa sed est aute officia\",\n \"desired_service_id\": \"b766e715-c46b-4ee9-2cb5-14587ab21692\",\n \"desired_provider_id\": \"urn:uuid:195e77f3-799a-a314-bbf4-d52b8db30d5b\",\n \"estimated_value_cents\": 85621970,\n \"priority\": \"normal\",\n \"tags\": [\n \"con\",\n \"su\"\n ],\n \"custom_fields\": {},\n \"marketing_opt_in\": true,\n \"sms_opt_in\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bde2bb5-d833-5063-adaf-d6e28443e380", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"record_type\": \"prospect\",\n \"first_name\": \"id occaeca\",\n \"last_name\": \"incididunt eiusmod aliquip mollit\",\n \"email\": \"sunt minim in cillum\",\n \"phone\": \"commodo aute fugiat\",\n \"company\": \"nisi amet consequat et\",\n \"lifecycle_stage\": \"waitlist\",\n \"pipeline_id\": \"cf0f9d8f-7697-f6a9-a007-df051976c363\",\n \"stage_id\": \"9cb92db0-2bff-f05d-e2fe-957cb1cccd3c\",\n \"source\": \"ullamco officia cillum est\",\n \"owner_staff_id\": \"urn:uuid:53489664-50aa-8a8c-4364-00b9702d5718\",\n \"referral_source_id\": \"urn:uuid:3d3fe517-26df-0529-d7b0-13f5aa11d72a\",\n \"interest\": \"culpa sed est aute officia\",\n \"desired_service_id\": \"b766e715-c46b-4ee9-2cb5-14587ab21692\",\n \"desired_provider_id\": \"urn:uuid:195e77f3-799a-a314-bbf4-d52b8db30d5b\",\n \"estimated_value_cents\": 85621970,\n \"priority\": \"normal\",\n \"tags\": [\n \"con\",\n \"su\"\n ],\n \"custom_fields\": {},\n \"marketing_opt_in\": true,\n \"sms_opt_in\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9429807-e098-5840-8bb3-4a49ed111e9f", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"record_type\": \"prospect\",\n \"first_name\": \"id occaeca\",\n \"last_name\": \"incididunt eiusmod aliquip mollit\",\n \"email\": \"sunt minim in cillum\",\n \"phone\": \"commodo aute fugiat\",\n \"company\": \"nisi amet consequat et\",\n \"lifecycle_stage\": \"waitlist\",\n \"pipeline_id\": \"cf0f9d8f-7697-f6a9-a007-df051976c363\",\n \"stage_id\": \"9cb92db0-2bff-f05d-e2fe-957cb1cccd3c\",\n \"source\": \"ullamco officia cillum est\",\n \"owner_staff_id\": \"urn:uuid:53489664-50aa-8a8c-4364-00b9702d5718\",\n \"referral_source_id\": \"urn:uuid:3d3fe517-26df-0529-d7b0-13f5aa11d72a\",\n \"interest\": \"culpa sed est aute officia\",\n \"desired_service_id\": \"b766e715-c46b-4ee9-2cb5-14587ab21692\",\n \"desired_provider_id\": \"urn:uuid:195e77f3-799a-a314-bbf4-d52b8db30d5b\",\n \"estimated_value_cents\": 85621970,\n \"priority\": \"normal\",\n \"tags\": [\n \"con\",\n \"su\"\n ],\n \"custom_fields\": {},\n \"marketing_opt_in\": true,\n \"sms_opt_in\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24b86617-2298-5f5b-8ad6-ae5569e729ed", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"record_type\": \"prospect\",\n \"first_name\": \"id occaeca\",\n \"last_name\": \"incididunt eiusmod aliquip mollit\",\n \"email\": \"sunt minim in cillum\",\n \"phone\": \"commodo aute fugiat\",\n \"company\": \"nisi amet consequat et\",\n \"lifecycle_stage\": \"waitlist\",\n \"pipeline_id\": \"cf0f9d8f-7697-f6a9-a007-df051976c363\",\n \"stage_id\": \"9cb92db0-2bff-f05d-e2fe-957cb1cccd3c\",\n \"source\": \"ullamco officia cillum est\",\n \"owner_staff_id\": \"urn:uuid:53489664-50aa-8a8c-4364-00b9702d5718\",\n \"referral_source_id\": \"urn:uuid:3d3fe517-26df-0529-d7b0-13f5aa11d72a\",\n \"interest\": \"culpa sed est aute officia\",\n \"desired_service_id\": \"b766e715-c46b-4ee9-2cb5-14587ab21692\",\n \"desired_provider_id\": \"urn:uuid:195e77f3-799a-a314-bbf4-d52b8db30d5b\",\n \"estimated_value_cents\": 85621970,\n \"priority\": \"normal\",\n \"tags\": [\n \"con\",\n \"su\"\n ],\n \"custom_fields\": {},\n \"marketing_opt_in\": true,\n \"sms_opt_in\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73da3f72-6f13-50ef-a6d0-16f1bb56a749", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"record_type\": \"prospect\",\n \"first_name\": \"id occaeca\",\n \"last_name\": \"incididunt eiusmod aliquip mollit\",\n \"email\": \"sunt minim in cillum\",\n \"phone\": \"commodo aute fugiat\",\n \"company\": \"nisi amet consequat et\",\n \"lifecycle_stage\": \"waitlist\",\n \"pipeline_id\": \"cf0f9d8f-7697-f6a9-a007-df051976c363\",\n \"stage_id\": \"9cb92db0-2bff-f05d-e2fe-957cb1cccd3c\",\n \"source\": \"ullamco officia cillum est\",\n \"owner_staff_id\": \"urn:uuid:53489664-50aa-8a8c-4364-00b9702d5718\",\n \"referral_source_id\": \"urn:uuid:3d3fe517-26df-0529-d7b0-13f5aa11d72a\",\n \"interest\": \"culpa sed est aute officia\",\n \"desired_service_id\": \"b766e715-c46b-4ee9-2cb5-14587ab21692\",\n \"desired_provider_id\": \"urn:uuid:195e77f3-799a-a314-bbf4-d52b8db30d5b\",\n \"estimated_value_cents\": 85621970,\n \"priority\": \"normal\",\n \"tags\": [\n \"con\",\n \"su\"\n ],\n \"custom_fields\": {},\n \"marketing_opt_in\": true,\n \"sms_opt_in\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53d62bf3-6e60-5f41-8a96-e1cacf8c0517", "name": "A contact's timeline of activities.", "request": { "name": "A contact's timeline of activities.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c98c9f5c-20cd-5dba-869d-d237be6c229f", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:40d13013-660d-3154-9da0-945e607749e2\",\n \"contact_id\": \"urn:uuid:53f7718a-b656-3dd0-f473-f344f0720fae\",\n \"actor_staff_id\": \"urn:uuid:885bc7ad-6031-9f8f-a4e9-77b44638f239\",\n \"type\": \"system\",\n \"subject\": \"tempor irure qui dolore\",\n \"body\": \"esse fugiat consequat\",\n \"metadata\": {},\n \"occurred_at\": \"2005-06-10T02:14:18.509Z\",\n \"created_at\": \"1967-08-19T04:13:48.142Z\"\n },\n {\n \"id\": \"urn:uuid:cd902f61-931c-e81b-afd6-6e0508a22661\",\n \"contact_id\": \"18bc994a-cf19-842a-e926-80180b109c8e\",\n \"actor_staff_id\": \"urn:uuid:d9c69cd7-5b64-7361-b8e8-cf54a37d94ea\",\n \"type\": \"null\",\n \"subject\": \"sit mollit\",\n \"body\": \"laboris laborum officia pariatur\",\n \"metadata\": {},\n \"occurred_at\": \"1959-02-07T14:20:29.026Z\",\n \"created_at\": \"2024-07-22T16:24:28.035Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"ad\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c27327-8f7e-5b47-8b97-f8ecb8ba0612", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d019a0b9-502e-5e8f-bc05-6efe74bb3021", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cd95e32-09ab-5cc9-b695-24c6b4d1f555", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04022248-1e4b-5dd1-b83a-738aa5b027c0", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b322eb1-1a69-51ad-8af7-f5ef91f24f4b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e2177c4-544e-5e25-813c-60ffcc39c5f7", "name": "Log a timeline activity (note, call, email, etc.) on a contact.", "request": { "name": "Log a timeline activity (note, call, email, etc.) on a contact.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"status_change\",\n \"subject\": \"sint labore est\",\n \"body\": \"est\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1f3bb0d4-b5fb-590b-be2e-73c436ad75cb", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"status_change\",\n \"subject\": \"sint labore est\",\n \"body\": \"est\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"27aec758-903d-3e99-616a-72e535ed6920\",\n \"contact_id\": \"urn:uuid:821a1071-d9bb-333e-ea8f-1badc40b9cea\",\n \"actor_staff_id\": \"urn:uuid:9c5fc0cd-8a5d-d2f7-af4b-024d388c9808\",\n \"type\": \"note\",\n \"subject\": \"occaecat eu\",\n \"body\": \"laborum aliqua voluptate nostrud\",\n \"metadata\": {},\n \"occurred_at\": \"1950-05-25T09:27:22.807Z\",\n \"created_at\": \"2023-09-14T23:54:35.604Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71346e9f-15fa-5406-96e6-0b417cba01ff", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"status_change\",\n \"subject\": \"sint labore est\",\n \"body\": \"est\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "740aeb51-ce15-5389-8bed-9c6cd0eff1a5", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"status_change\",\n \"subject\": \"sint labore est\",\n \"body\": \"est\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92ca80f2-5f30-5633-8476-4032beb5160f", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"status_change\",\n \"subject\": \"sint labore est\",\n \"body\": \"est\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c79a680-dce9-5dc2-a801-b018534e1a1c", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"status_change\",\n \"subject\": \"sint labore est\",\n \"body\": \"est\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e2029d0-cd0b-57bc-9e20-e0bdb859a0eb", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "crm", "contacts", ":contact_id", "activities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "contact_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"status_change\",\n \"subject\": \"sint labore est\",\n \"body\": \"est\",\n \"metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "88ffccaf-7503-5f13-af47-83e1f528c854", "name": "Notes", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "19842145-765f-52ab-ad6f-9cd646a672a4", "name": "List one patient's clinical notes — metadata only, never note content.", "request": { "name": "List one patient's clinical notes — metadata only, never note content.", "description": { "content": "patient_id is required.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "73f6e44a-34f4-57f4-871c-b78235a1fb52", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:f184609b-640a-3572-57da-fd9198980e31\",\n \"status\": \"locked\",\n \"patient_id\": \"urn:uuid:72339c7a-1d5a-663c-76c1-7979709d58f7\",\n \"title\": \"incididunt nisi adipisicing qui\",\n \"note_type\": \"deserunt\",\n \"is_signed\": true,\n \"signed_at\": \"1960-10-18T16:40:30.798Z\",\n \"origin\": \"assistant_external\",\n \"origin_assistant_name\": \"id nisi consequat ad\",\n \"is_reviewed\": false,\n \"reviewed_at\": \"1969-09-11T12:50:58.067Z\",\n \"created_at\": \"1998-09-18T15:27:12.936Z\",\n \"updated_at\": \"1948-10-06T11:58:18.504Z\"\n },\n {\n \"id\": \"urn:uuid:28cfe469-658c-0d61-3da5-f30e3e332bb5\",\n \"status\": \"completed\",\n \"patient_id\": \"13d91985-06d8-5d97-ceae-7d9af65752a9\",\n \"title\": \"aliqua magna reprehenderit mollit officia\",\n \"note_type\": \"in ut pariatur minim\",\n \"is_signed\": true,\n \"signed_at\": \"1974-07-22T17:05:52.432Z\",\n \"origin\": \"staff\",\n \"origin_assistant_name\": \"fugiat sit ut velit\",\n \"is_reviewed\": false,\n \"reviewed_at\": \"1958-01-22T17:23:22.357Z\",\n \"created_at\": \"1950-04-04T22:09:12.659Z\",\n \"updated_at\": \"1988-02-04T01:44:04.729Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"in voluptate\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4cda700-8644-53bd-a895-e6d67586e8e3", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25518bb8-27a3-558b-929b-a62170d6ed84", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34f2635a-d93a-591c-8d27-0dc898291eed", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afb414e5-0b8f-51bb-aca9-c383fa667bc2", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2bcb734-e0ca-5b4c-8287-ceaa86bf0a33", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "043996ca-7ec0-59bf-ac37-c678b8483979", "name": "Create a DRAFT note. Always status=draft — this route can never sign, lock, finalize or co-sign.", "request": { "name": "Create a DRAFT note. Always status=draft — this route can never sign, lock, finalize or co-sign.", "description": { "content": "clinician_id is the clinic_staff.id the draft is FOR, never the API caller. Unknown content keys are refused (unknown_field) naming both the offending keys and the full valid list for whichever template note_type/custom_template_id resolves to.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:5ffd2029-bfda-9ee9-cc34-dfa4a7617e1e\",\n \"clinician_id\": \"urn:uuid:ef254ee0-8595-fcae-e54f-26676d988884\",\n \"content\": {},\n \"note_type\": \"id Lorem\",\n \"custom_template_id\": \"urn:uuid:22203699-449b-d88d-78b1-78887546d363\",\n \"origin_assistant_name\": \"aute ut enim aliquip officia\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d488631c-2ad5-5c5e-b1a8-26bcc0576b07", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a42e02fe-9eaa-64b5-9916-d7dfc3c67621\",\n \"clinician_id\": \"urn:uuid:10006e7e-4043-8578-05b1-02df8047e1ac\",\n \"content\": {},\n \"note_type\": \"ut aute\",\n \"custom_template_id\": \"cc5c89e7-ae2c-7251-4da7-0087df1139db\",\n \"origin_assistant_name\": \"pariatur in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:0cb75526-13ba-ccdf-cf12-211bd089af4f\",\n \"status\": \"completed\",\n \"patient_id\": \"urn:uuid:82e64557-22a4-a685-d2d1-848830813c5c\",\n \"title\": \"laborum in ut\",\n \"note_type\": \"ipsum\",\n \"is_signed\": false,\n \"signed_at\": \"1953-07-31T07:40:06.476Z\",\n \"origin\": \"staff\",\n \"origin_assistant_name\": \"eiusmod elit nostrud\",\n \"is_reviewed\": true,\n \"reviewed_at\": \"2001-04-01T15:20:55.727Z\",\n \"created_at\": \"1980-07-27T11:47:34.659Z\",\n \"updated_at\": \"2023-02-02T10:23:27.518Z\",\n \"custom_template_id\": \"urn:uuid:c24c53f6-802c-a446-0428-69106b4aa5b3\",\n \"content\": {},\n \"citations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c283f02-4ed9-5e3a-892c-501a65af28a5", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a42e02fe-9eaa-64b5-9916-d7dfc3c67621\",\n \"clinician_id\": \"urn:uuid:10006e7e-4043-8578-05b1-02df8047e1ac\",\n \"content\": {},\n \"note_type\": \"ut aute\",\n \"custom_template_id\": \"cc5c89e7-ae2c-7251-4da7-0087df1139db\",\n \"origin_assistant_name\": \"pariatur in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e227ad8a-dcbb-5bf9-950f-9ac9c549a3bf", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a42e02fe-9eaa-64b5-9916-d7dfc3c67621\",\n \"clinician_id\": \"urn:uuid:10006e7e-4043-8578-05b1-02df8047e1ac\",\n \"content\": {},\n \"note_type\": \"ut aute\",\n \"custom_template_id\": \"cc5c89e7-ae2c-7251-4da7-0087df1139db\",\n \"origin_assistant_name\": \"pariatur in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3155f789-0be3-5f0a-8e85-85956de1cf98", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a42e02fe-9eaa-64b5-9916-d7dfc3c67621\",\n \"clinician_id\": \"urn:uuid:10006e7e-4043-8578-05b1-02df8047e1ac\",\n \"content\": {},\n \"note_type\": \"ut aute\",\n \"custom_template_id\": \"cc5c89e7-ae2c-7251-4da7-0087df1139db\",\n \"origin_assistant_name\": \"pariatur in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13aab810-7ada-5b3e-914e-af74e745b916", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a42e02fe-9eaa-64b5-9916-d7dfc3c67621\",\n \"clinician_id\": \"urn:uuid:10006e7e-4043-8578-05b1-02df8047e1ac\",\n \"content\": {},\n \"note_type\": \"ut aute\",\n \"custom_template_id\": \"cc5c89e7-ae2c-7251-4da7-0087df1139db\",\n \"origin_assistant_name\": \"pariatur in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d14a8591-d197-5c84-aa37-7afe6557f1fb", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a42e02fe-9eaa-64b5-9916-d7dfc3c67621\",\n \"clinician_id\": \"urn:uuid:10006e7e-4043-8578-05b1-02df8047e1ac\",\n \"content\": {},\n \"note_type\": \"ut aute\",\n \"custom_template_id\": \"cc5c89e7-ae2c-7251-4da7-0087df1139db\",\n \"origin_assistant_name\": \"pariatur in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fefbe03-77c8-5d33-aada-c19701541899", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a42e02fe-9eaa-64b5-9916-d7dfc3c67621\",\n \"clinician_id\": \"urn:uuid:10006e7e-4043-8578-05b1-02df8047e1ac\",\n \"content\": {},\n \"note_type\": \"ut aute\",\n \"custom_template_id\": \"cc5c89e7-ae2c-7251-4da7-0087df1139db\",\n \"origin_assistant_name\": \"pariatur in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "195d6856-8ce1-506f-b3c0-3ba53b43f87b", "name": "Get one note, including its content.", "request": { "name": "Get one note, including its content.", "description": { "content": "A signed/finalized note, a restricted patient's note, or a sensitivity-flagged note, answers not_found.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a42c340e-3925-5264-96d4-c1c068f97a83", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:0cb75526-13ba-ccdf-cf12-211bd089af4f\",\n \"status\": \"completed\",\n \"patient_id\": \"urn:uuid:82e64557-22a4-a685-d2d1-848830813c5c\",\n \"title\": \"laborum in ut\",\n \"note_type\": \"ipsum\",\n \"is_signed\": false,\n \"signed_at\": \"1953-07-31T07:40:06.476Z\",\n \"origin\": \"staff\",\n \"origin_assistant_name\": \"eiusmod elit nostrud\",\n \"is_reviewed\": true,\n \"reviewed_at\": \"2001-04-01T15:20:55.727Z\",\n \"created_at\": \"1980-07-27T11:47:34.659Z\",\n \"updated_at\": \"2023-02-02T10:23:27.518Z\",\n \"custom_template_id\": \"urn:uuid:c24c53f6-802c-a446-0428-69106b4aa5b3\",\n \"content\": {},\n \"citations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dcdf275-10ea-59d1-a161-f32419f377cb", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9602953f-29a8-5040-96fe-0f16da5235db", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "355e4890-4662-5cfc-bceb-6b48212e4102", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6474f302-489f-5fb6-adab-37b90c598bf9", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e76e2c86-28d3-5693-936c-89caa0e03649", "name": "Update a draft this key created, if no clinician has touched it since.", "request": { "name": "Update a draft this key created, if no clinician has touched it since.", "description": { "content": "Refused note_not_editable if the note is signed/locked/finalized or a clinician saved it since this key's own last write.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "072d70c1-8423-51ff-9979-8a94b791c456", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:0cb75526-13ba-ccdf-cf12-211bd089af4f\",\n \"status\": \"completed\",\n \"patient_id\": \"urn:uuid:82e64557-22a4-a685-d2d1-848830813c5c\",\n \"title\": \"laborum in ut\",\n \"note_type\": \"ipsum\",\n \"is_signed\": false,\n \"signed_at\": \"1953-07-31T07:40:06.476Z\",\n \"origin\": \"staff\",\n \"origin_assistant_name\": \"eiusmod elit nostrud\",\n \"is_reviewed\": true,\n \"reviewed_at\": \"2001-04-01T15:20:55.727Z\",\n \"created_at\": \"1980-07-27T11:47:34.659Z\",\n \"updated_at\": \"2023-02-02T10:23:27.518Z\",\n \"custom_template_id\": \"urn:uuid:c24c53f6-802c-a446-0428-69106b4aa5b3\",\n \"content\": {},\n \"citations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcf235ae-b0b8-5788-834b-25fae90e53d1", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3a90db5-9467-5d3d-afb0-461a9cb524d3", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "324b96e7-5b9f-5d55-bebf-a87f4bbd0710", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1fe0694-6269-59a9-83bd-1d34320f7b57", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79b2f42b-20b1-5743-bd6b-944dbc8cccb8", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "951a993f-ffbf-5969-a420-be3b701e5109", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "note_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35a8f445-a2ca-5423-a59d-023fc6af8186", "name": "Every static template plus this clinic's own active custom templates.", "request": { "name": "Every static template plus this clinic's own active custom templates.", "description": { "content": "key is exactly what createNote expects (note_type for static, custom_template_id for custom).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "note-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c1e849c9-c933-5165-9208-f6487fe18142", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"key\": \"nostrud ea do ad\",\n \"kind\": \"static\",\n \"title\": \"occaecat amet\",\n \"category\": \"dolore sit dolor anim\",\n \"description\": \"\",\n \"version\": -81697095\n },\n {\n \"key\": \"irure cupidatat ad\",\n \"kind\": \"custom_template\",\n \"title\": \"eu sunt cillum dolore\",\n \"category\": \"in aliqua Excepteur labore\",\n \"description\": \"mollit labore\",\n \"version\": -90056365\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68c95179-6285-550b-8b3b-84f92dd266dd", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea3bd793-522e-5f90-9ef5-709a83a40344", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb73aff4-332e-5086-89c7-12d9a899098d", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64de8c4d-3849-5783-93b6-c8316442db9d", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b04a2d6b-7c5d-56be-8b1a-c4d0f9dcfa52", "name": "Every field's id/order/title/type/required/options for one template.", "request": { "name": "Every field's id/order/title/type/required/options for one template.", "description": { "content": "template_key is a static template's exact name (URL-encoded) or this clinic's own custom template id — never a UUID for the static case.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "note-templates", ":template_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "culpa qui consectetur", "key": "template_key", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2b43f7de-b729-53d8-bd3e-6e6d4fc86ccc", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates", ":template_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "culpa qui consectetur", "key": "template_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"anim sit\",\n \"order\": 29191993,\n \"title\": \"nostrud\",\n \"type\": \"laborum enim\",\n \"required\": false,\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"sit aute\",\n \"order\": -37434579,\n \"title\": \"ex\",\n \"type\": \"fugiat commodo\",\n \"required\": true,\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b970aa4-2438-5282-8a77-c533731a843d", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates", ":template_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "culpa qui consectetur", "key": "template_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8226d023-7d11-5c53-a47c-4ea83ed3af6b", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates", ":template_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "culpa qui consectetur", "key": "template_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bf036dd-794d-5f40-b05a-f5d1df4b37fc", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates", ":template_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "culpa qui consectetur", "key": "template_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7576d6a-21b1-500c-8257-c91181f07c16", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-templates", ":template_key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "culpa qui consectetur", "key": "template_key", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "924fba6d-1e81-5403-88ff-d039fb6089a0", "name": "Every clinic_staff member whose role may hold a note.", "request": { "name": "Every clinic_staff member whose role may hold a note.", "description": { "content": "id/display_name/role/active only — no email, phone, or licence number.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "note-clinicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "32afe1ff-d688-52c0-82f9-3f1a4d0c5c40", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-clinicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:fad73fdf-2003-ebbd-cac8-4f8893fd5f72\",\n \"display_name\": \"dol\",\n \"role\": \"Excepteur cillum\",\n \"active\": true\n },\n {\n \"id\": \"61aa7f19-7423-787a-2665-0c89f8b41550\",\n \"display_name\": \"laboris commodo sit anim\",\n \"role\": \"sit enim reprehenderit id\",\n \"active\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac14916a-67f8-51ab-9ced-4bdd3fe88642", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-clinicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b04672fd-917c-59f4-b8c7-57da800da299", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-clinicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9906ad4c-355a-5c25-9b92-958780250438", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-clinicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38754935-74f0-553f-9207-4ab850a7e1b6", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "note-clinicians" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "265233cb-8ec7-59f8-9f8f-c880b1f9cb4a", "name": "Appointments", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9cf194fe-0aa6-5ad3-9231-b4da583d52d8", "name": "Bookable services — discovery, non-PHI.", "request": { "name": "Bookable services — discovery, non-PHI.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "appointments", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "81011a3e-9f3e-5c0f-9656-c1cc157849f5", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"359c1d57-a1a3-806c-bedb-241073cf4fb6\",\n \"name\": \"cillum mollit consequat labore irure\",\n \"duration_minutes\": -71193526,\n \"category\": \"dolore labore\",\n \"is_active\": false\n },\n {\n \"id\": \"0c07806c-2e2e-e5df-91fe-dab69bba3d19\",\n \"name\": \"sit et ullamco\",\n \"duration_minutes\": -89509304,\n \"category\": \"enim minim do occaecat\",\n \"is_active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd0a5f7f-1334-567f-92ac-befe30601c57", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53c2e65-d97f-58a5-8efb-5b45ffdb14d8", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fdf9b3e-3e5a-5522-9a2c-9bbc3a20cc66", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d18139f2-23c0-59b3-a60c-6c4d42a6bb4b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0904bf3b-36cc-592a-a100-c1b5c0ef106a", "name": "Clinicians, optionally filtered to those offering one service — discovery, non-PHI.", "request": { "name": "Clinicians, optionally filtered to those offering one service — discovery, non-PHI.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "appointments", "clinicians" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d3baeba1-1200-5eea-9c42-fe1c39fc6e9f", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "clinicians" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:455efd7a-af2f-4c7a-7819-e1038ca5c9a3\",\n \"display_name\": \"irure laboris\",\n \"role\": \"est consequ\"\n },\n {\n \"id\": \"urn:uuid:adfebec4-552b-09b5-c991-b097d9c67fa0\",\n \"display_name\": \"fugiat\",\n \"role\": \"minim ex tempor occaecat\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "077f3a4e-8777-5b01-9ddd-57b6dbf14af0", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "clinicians" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "443d9059-3e5d-525c-b2e5-b4a7114331c8", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "clinicians" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54c6f489-800c-5ea1-8bc2-b11c6ec07d71", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "clinicians" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6b67d87-2acc-5286-bdde-0a1c4b789ef5", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "clinicians" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a1799ab-3b0e-5576-8498-dbea78faad38", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "clinicians" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f146df54-92ed-579c-8fd1-e1477c5fec5a", "name": "Bookable slots for a service over a date range — discovery, non-PHI.", "request": { "name": "Bookable slots for a service over a date range — discovery, non-PHI.", "description": { "content": "Range clamped to 60 days.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "appointments", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "from", "value": "1984-02-27", "description": "(Required) " }, { "disabled": false, "key": "to", "value": "1984-02-27", "description": "(Required) " }, { "disabled": false, "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "disabled": false, "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "806b4089-df8a-575e-b60d-f155774a4273", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"clinician_id\": \"4d01e009-871a-b099-bb9f-845abe1322ec\",\n \"date\": \"1972-05-17\",\n \"time\": \"esse ex amet id\",\n \"capacity\": -72978274\n },\n {\n \"clinician_id\": \"3ab41870-842b-7c25-64c5-10633ad37562\",\n \"date\": \"1971-08-25\",\n \"time\": \"est magna pariatur quis\",\n \"capacity\": 97425872\n }\n ],\n \"timezone\": \"ad proident velit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fc8e746-7950-5183-81a5-d8f751193385", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bb5592f-3fa7-59f7-993f-9d854f9bd2b2", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4db3a00d-0d87-5462-a064-a214eb2582b6", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a4af000-1a64-5a8d-8312-4944c002c62c", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebe0b467-8778-5fd5-b55f-98eabafa43b2", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", "availability" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "service_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "location_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb520f85-cea6-557a-bf9b-b706f18e0b88", "name": "List appointments.", "request": { "name": "List appointments.", "description": { "content": "A restricted patient's appointment is excluded. Date range clamped to 366 days.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "culpa qui consectetur" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "disabled": false, "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "disabled": false, "key": "status", "value": "completed" }, { "disabled": false, "key": "from", "value": "1984-02-27" }, { "disabled": false, "key": "to", "value": "1984-02-27" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3b283792-472a-5d4b-9421-1c1441736ee0", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "completed" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"8f1fc958-994a-c34b-b54d-417339749e76\",\n \"status\": \"confirmed\",\n \"patient_id\": \"urn:uuid:466a494e-0b7f-7ca4-c775-fa9ab98a2c0c\",\n \"service_id\": \"6f27f965-e233-f5c4-422e-a5f06a75d23d\",\n \"clinician_id\": \"7bbc881c-808d-d1cf-90a9-5a0280dad133\",\n \"start_at\": \"1983-11-11T23:08:28.183Z\",\n \"end_at\": \"1991-02-13T23:10:46.271Z\",\n \"duration_minutes\": 10186098,\n \"timezone\": \"minim tempor ex magna\",\n \"venue_type\": \"null\",\n \"venue_details\": {},\n \"booking_source\": \"aliqua eiusmod\",\n \"patient_notes\": \"ipsum deserunt labo\",\n \"clinic_notes\": \"non ullamco dolore ea amet\",\n \"symptoms_description\": \"labore dolore eiusmod Lorem ut\",\n \"urgency_level\": \"null\",\n \"ai_category\": \"dolor\",\n \"ai_priority_score\": -20950900.251045823,\n \"ai_suggested_duration\": 21985294.856131077,\n \"predicted_show_probability\": 17118366.94739759,\n \"confirmation_sent_at\": \"2020-02-14T09:02:10.144Z\",\n \"confirmation_method\": \"aliquip velit\",\n \"reminder_sent_at\": \"1993-08-19T16:24:23.624Z\",\n \"reminder_method\": \"laboris dolore\",\n \"reminder_sent\": true,\n \"payment_status\": \"pending\",\n \"payment_method\": \"velit\",\n \"payment_amount\": 3112057.177349925,\n \"payment_due_date\": \"1959-02-26\",\n \"amount_paid\": 91052623.65192175,\n \"payment_id\": \"Ut nulla minim adipisic\",\n \"confirmation_code\": \"labore irure in id\",\n \"cancellation_reason\": \"qui tempor anim do\",\n \"cancelled_at\": \"1990-02-09T10:44:59.736Z\",\n \"completed_at\": \"1973-06-25T21:02:23.822Z\",\n \"is_group_appointment\": true,\n \"max_participants\": -62741213,\n \"group_name\": \"exercitation in culpa do labore\",\n \"recurrence_pattern_id\": \"urn:uuid:779b9031-dafe-5647-b45f-91e5ffbe79eb\",\n \"series_id\": \"bf9ca5ab-4eeb-5175-b52b-a78692cf3591\",\n \"series_index\": -27988453,\n \"email_notifications\": false,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"notes_session_ids\": [\n \"urn:uuid:23f86925-d09c-4cd2-79a8-e303b31d92bc\",\n \"urn:uuid:d8d8a5fd-f05b-3c59-f07e-4a03537a98dd\"\n ],\n \"class_session_id\": \"urn:uuid:60861476-1c8b-40a8-1788-f8bc5d67f56f\",\n \"self_reschedule_count\": -46180862,\n \"location_id\": \"3cf1dfdc-1c44-a84a-c976-be6235d8868e\",\n \"participants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"2003-08-05T00:53:37.496Z\",\n \"updated_at\": \"1959-06-14T07:35:22.599Z\"\n },\n {\n \"id\": \"urn:uuid:08c19c8a-6502-2c92-3ffa-d9d5f6fb9777\",\n \"status\": \"confirmed\",\n \"patient_id\": \"urn:uuid:7b0a2cb0-d973-db25-71ff-c9f784440c32\",\n \"service_id\": \"7251221a-9fc2-ef33-9395-455547d3386d\",\n \"clinician_id\": \"urn:uuid:3cfbda20-6b82-dfc2-4a04-13853dba2d56\",\n \"start_at\": \"2016-04-21T14:45:23.526Z\",\n \"end_at\": \"1949-06-21T15:07:45.399Z\",\n \"duration_minutes\": 17119803,\n \"timezone\": \"sed ipsum Ut officia Duis\",\n \"venue_type\": \"mobile_clinic\",\n \"venue_details\": {},\n \"booking_source\": \"aliquip enim ut\",\n \"patient_notes\": \"e\",\n \"clinic_notes\": \"Excepteur laboris \",\n \"symptoms_description\": \"adipisicing id\",\n \"urgency_level\": \"high\",\n \"ai_category\": \"laboris labore\",\n \"ai_priority_score\": 78328077.68136263,\n \"ai_suggested_duration\": -25853531.481698155,\n \"predicted_show_probability\": 54329801.58366263,\n \"confirmation_sent_at\": \"1959-12-31T17:19:08.808Z\",\n \"confirmation_method\": \"Excepteur\",\n \"reminder_sent_at\": \"2015-01-20T03:52:21.483Z\",\n \"reminder_method\": \"amet anim\",\n \"reminder_sent\": true,\n \"payment_status\": \"null\",\n \"payment_method\": \"voluptate officia\",\n \"payment_amount\": -30597062.315791845,\n \"payment_due_date\": \"2020-03-07\",\n \"amount_paid\": 30960102.14649141,\n \"payment_id\": \"sint Ut laborum\",\n \"confirmation_code\": \"deserunt sit\",\n \"cancellation_reason\": \"commodo adipisicing id deserunt do\",\n \"cancelled_at\": \"1984-04-01T05:19:14.573Z\",\n \"completed_at\": \"1951-01-26T10:12:02.479Z\",\n \"is_group_appointment\": true,\n \"max_participants\": -47023865,\n \"group_name\": \"velit Ut Lorem dolore proident\",\n \"recurrence_pattern_id\": \"dc1c0c6e-04eb-0094-44e4-4f814aaaf63f\",\n \"series_id\": \"a3181b23-2997-0b08-f589-75212f1964e0\",\n \"series_index\": -34356558,\n \"email_notifications\": false,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"notes_session_ids\": [\n \"0d6307bc-4350-94ea-8647-abdcb1137714\",\n \"urn:uuid:d03f2963-b610-077b-5933-0e02414dd848\"\n ],\n \"class_session_id\": \"urn:uuid:997f37fb-3005-8640-cafb-6454b44679f4\",\n \"self_reschedule_count\": 40037894,\n \"location_id\": \"6fdde0e1-2f3b-1bba-5827-06036b30660b\",\n \"participants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_at\": \"1968-02-25T14:52:40.436Z\",\n \"updated_at\": \"1985-11-15T06:30:26.635Z\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"commodo ex mi\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52078e50-8210-5a71-9866-cb52002cdc91", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "completed" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07d1ca11-7f74-5824-80ec-56eceeb1b122", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "completed" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "019d723e-fe73-54ba-b9f9-44420db6b126", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "completed" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a280d24-b886-504d-a2ce-16d55d0ffe19", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "completed" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6771c152-370d-5904-9f62-2aa86ace6bc6", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "culpa qui consectetur" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "clinician_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "completed" }, { "key": "from", "value": "1984-02-27" }, { "key": "to", "value": "1984-02-27" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3bd3ac6c-305e-50b1-b3ee-2589fd69c80d", "name": "Book an appointment — the same eligibility, out-of-office and double-booking rules as the app.", "request": { "name": "Book an appointment — the same eligibility, out-of-office and double-booking rules as the app.", "description": { "content": "REQUIRED FOLLOW-UP: multi-service visit plans, package/deposit/discount redemption, default-document assignment and group appointments are NOT reproduced — a scope cut, not a bug.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db1d7126-b412-5335-b3dd-1af0e746aa34", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"95603f3b-6776-8a57-218c-2b1b2d62581a\",\n \"status\": \"in_progress\",\n \"patient_id\": \"5d07b3ef-3024-28e2-c14b-ebc3bd51bac2\",\n \"service_id\": \"5261b8a4-c950-6771-a773-0567c7bde80e\",\n \"clinician_id\": \"urn:uuid:6b30c321-35a3-3a38-1200-04ec69d4283f\",\n \"start_at\": \"1969-08-12T06:28:11.510Z\",\n \"end_at\": \"1979-06-29T20:19:51.904Z\",\n \"duration_minutes\": 76956243,\n \"timezone\": \"nulla Excepteur do officia sed\",\n \"venue_type\": \"null\",\n \"venue_details\": {},\n \"booking_source\": \"esse\",\n \"patient_notes\": \"nostrud veniam qui\",\n \"clinic_notes\": \"sit\",\n \"symptoms_description\": \"aute Duis officia aliqui\",\n \"urgency_level\": \"low\",\n \"ai_category\": \"eiusmod do id\",\n \"ai_priority_score\": 51950229.19215262,\n \"ai_suggested_duration\": 44670390.244573355,\n \"predicted_show_probability\": -14063833.700492978,\n \"confirmation_sent_at\": \"1981-08-26T20:58:05.417Z\",\n \"confirmation_method\": \"eiusmod incididunt\",\n \"reminder_sent_at\": \"2021-09-24T18:31:46.973Z\",\n \"reminder_method\": \"minim comm\",\n \"reminder_sent\": false,\n \"payment_status\": \"waived\",\n \"payment_method\": \"esse consectetur labore\",\n \"payment_amount\": 48946552.723646164,\n \"payment_due_date\": \"1960-07-10\",\n \"amount_paid\": -35730977.03047097,\n \"payment_id\": \"ad adipisicing\",\n \"confirmation_code\": \"aliqua qui nostrud\",\n \"cancellation_reason\": \"sint in quis qui eu\",\n \"cancelled_at\": \"1967-11-29T12:59:52.170Z\",\n \"completed_at\": \"2010-12-03T10:11:31.030Z\",\n \"is_group_appointment\": false,\n \"max_participants\": -95633956,\n \"group_name\": \"Duis voluptate culpa\",\n \"recurrence_pattern_id\": \"urn:uuid:0d09a7fa-7bad-1292-ecc9-3e63cb829536\",\n \"series_id\": \"f1e55e66-9595-c9a9-567d-ef2d5ea547c0\",\n \"series_index\": 29835878,\n \"email_notifications\": true,\n \"sms_notifications\": false,\n \"voice_notifications\": true,\n \"notes_session_ids\": [\n \"0ce27eef-4f34-07fa-6d63-6a6fbed933fa\",\n \"7e8b59a1-6e8f-bda0-a706-cb19363fb9d0\"\n ],\n \"class_session_id\": \"c9697f4a-5152-9d7c-54f5-eb0608792452\",\n \"self_reschedule_count\": 2990146,\n \"location_id\": \"21639d60-ac5f-a078-fba3-08e87895e31a\",\n \"participants\": [\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n },\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"1973-08-25T04:18:54.293Z\",\n \"updated_at\": \"2016-03-23T07:40:15.739Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00265bd9-8981-5f76-9745-73c76adb66e9", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9693d355-e5c6-5657-b136-c62e0b174957", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "073a636e-239b-5533-bc39-a40bb9faf39e", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b384cfd-016b-5058-b656-2c4bec779d22", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5255420e-e0e1-5da1-a6dd-f292a388043e", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7280e457-310a-5da7-9527-af3650d90095", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:f6c491bb-8fa2-47dd-fddd-608dab280b0b\",\n \"service_id\": \"7b821f88-33d6-83d3-2131-abf8378798dd\",\n \"start_at\": \"2013-02-23T16:17:37.311Z\",\n \"clinician_id\": \"urn:uuid:10b1f8c6-2cbf-1bc8-f6c8-4249507630a1\",\n \"location_id\": \"urn:uuid:1aeae7eb-5dc5-1cf6-64de-757a4ee05677\",\n \"venue_type\": \"physical\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"ut sed nisi sit qui\",\n \"clinic_notes\": \"quis adipisicing fugiat et sit\",\n \"symptoms_description\": \"eu deserunt\",\n \"status\": \"scheduled\",\n \"payment_amount\": -4951587.691903114,\n \"payment_method\": \"sunt e\",\n \"payment_status\": \"pending\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e58a4d32-7538-5ef2-aaa8-f0783c9ec3fe", "name": "Get one appointment.", "request": { "name": "Get one appointment.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d239e7e5-22df-5a2f-8efe-d08378ba3acd", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"95603f3b-6776-8a57-218c-2b1b2d62581a\",\n \"status\": \"in_progress\",\n \"patient_id\": \"5d07b3ef-3024-28e2-c14b-ebc3bd51bac2\",\n \"service_id\": \"5261b8a4-c950-6771-a773-0567c7bde80e\",\n \"clinician_id\": \"urn:uuid:6b30c321-35a3-3a38-1200-04ec69d4283f\",\n \"start_at\": \"1969-08-12T06:28:11.510Z\",\n \"end_at\": \"1979-06-29T20:19:51.904Z\",\n \"duration_minutes\": 76956243,\n \"timezone\": \"nulla Excepteur do officia sed\",\n \"venue_type\": \"null\",\n \"venue_details\": {},\n \"booking_source\": \"esse\",\n \"patient_notes\": \"nostrud veniam qui\",\n \"clinic_notes\": \"sit\",\n \"symptoms_description\": \"aute Duis officia aliqui\",\n \"urgency_level\": \"low\",\n \"ai_category\": \"eiusmod do id\",\n \"ai_priority_score\": 51950229.19215262,\n \"ai_suggested_duration\": 44670390.244573355,\n \"predicted_show_probability\": -14063833.700492978,\n \"confirmation_sent_at\": \"1981-08-26T20:58:05.417Z\",\n \"confirmation_method\": \"eiusmod incididunt\",\n \"reminder_sent_at\": \"2021-09-24T18:31:46.973Z\",\n \"reminder_method\": \"minim comm\",\n \"reminder_sent\": false,\n \"payment_status\": \"waived\",\n \"payment_method\": \"esse consectetur labore\",\n \"payment_amount\": 48946552.723646164,\n \"payment_due_date\": \"1960-07-10\",\n \"amount_paid\": -35730977.03047097,\n \"payment_id\": \"ad adipisicing\",\n \"confirmation_code\": \"aliqua qui nostrud\",\n \"cancellation_reason\": \"sint in quis qui eu\",\n \"cancelled_at\": \"1967-11-29T12:59:52.170Z\",\n \"completed_at\": \"2010-12-03T10:11:31.030Z\",\n \"is_group_appointment\": false,\n \"max_participants\": -95633956,\n \"group_name\": \"Duis voluptate culpa\",\n \"recurrence_pattern_id\": \"urn:uuid:0d09a7fa-7bad-1292-ecc9-3e63cb829536\",\n \"series_id\": \"f1e55e66-9595-c9a9-567d-ef2d5ea547c0\",\n \"series_index\": 29835878,\n \"email_notifications\": true,\n \"sms_notifications\": false,\n \"voice_notifications\": true,\n \"notes_session_ids\": [\n \"0ce27eef-4f34-07fa-6d63-6a6fbed933fa\",\n \"7e8b59a1-6e8f-bda0-a706-cb19363fb9d0\"\n ],\n \"class_session_id\": \"c9697f4a-5152-9d7c-54f5-eb0608792452\",\n \"self_reschedule_count\": 2990146,\n \"location_id\": \"21639d60-ac5f-a078-fba3-08e87895e31a\",\n \"participants\": [\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n },\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"1973-08-25T04:18:54.293Z\",\n \"updated_at\": \"2016-03-23T07:40:15.739Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c98f4896-fbc3-5af5-9b10-01972f7119f2", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3301c147-22c7-5bf2-aabb-78ab2f91b55b", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77c1c855-a57b-5822-9158-7367db6ec070", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffa54a2e-13f3-51c5-a12e-395e4f7ec109", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "893dd3cf-3183-5b60-b795-614075ce0123", "name": "Reschedule or update an appointment. Immutable after create — patient_id, service_id, location_id, every payment field — are refused if sent.", "request": { "name": "Reschedule or update an appointment. Immutable after create — patient_id, service_id, location_id, every payment field — are refused if sent.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9d28fc50-ae4e-5844-a33a-cd9d8c8308c5", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"95603f3b-6776-8a57-218c-2b1b2d62581a\",\n \"status\": \"in_progress\",\n \"patient_id\": \"5d07b3ef-3024-28e2-c14b-ebc3bd51bac2\",\n \"service_id\": \"5261b8a4-c950-6771-a773-0567c7bde80e\",\n \"clinician_id\": \"urn:uuid:6b30c321-35a3-3a38-1200-04ec69d4283f\",\n \"start_at\": \"1969-08-12T06:28:11.510Z\",\n \"end_at\": \"1979-06-29T20:19:51.904Z\",\n \"duration_minutes\": 76956243,\n \"timezone\": \"nulla Excepteur do officia sed\",\n \"venue_type\": \"null\",\n \"venue_details\": {},\n \"booking_source\": \"esse\",\n \"patient_notes\": \"nostrud veniam qui\",\n \"clinic_notes\": \"sit\",\n \"symptoms_description\": \"aute Duis officia aliqui\",\n \"urgency_level\": \"low\",\n \"ai_category\": \"eiusmod do id\",\n \"ai_priority_score\": 51950229.19215262,\n \"ai_suggested_duration\": 44670390.244573355,\n \"predicted_show_probability\": -14063833.700492978,\n \"confirmation_sent_at\": \"1981-08-26T20:58:05.417Z\",\n \"confirmation_method\": \"eiusmod incididunt\",\n \"reminder_sent_at\": \"2021-09-24T18:31:46.973Z\",\n \"reminder_method\": \"minim comm\",\n \"reminder_sent\": false,\n \"payment_status\": \"waived\",\n \"payment_method\": \"esse consectetur labore\",\n \"payment_amount\": 48946552.723646164,\n \"payment_due_date\": \"1960-07-10\",\n \"amount_paid\": -35730977.03047097,\n \"payment_id\": \"ad adipisicing\",\n \"confirmation_code\": \"aliqua qui nostrud\",\n \"cancellation_reason\": \"sint in quis qui eu\",\n \"cancelled_at\": \"1967-11-29T12:59:52.170Z\",\n \"completed_at\": \"2010-12-03T10:11:31.030Z\",\n \"is_group_appointment\": false,\n \"max_participants\": -95633956,\n \"group_name\": \"Duis voluptate culpa\",\n \"recurrence_pattern_id\": \"urn:uuid:0d09a7fa-7bad-1292-ecc9-3e63cb829536\",\n \"series_id\": \"f1e55e66-9595-c9a9-567d-ef2d5ea547c0\",\n \"series_index\": 29835878,\n \"email_notifications\": true,\n \"sms_notifications\": false,\n \"voice_notifications\": true,\n \"notes_session_ids\": [\n \"0ce27eef-4f34-07fa-6d63-6a6fbed933fa\",\n \"7e8b59a1-6e8f-bda0-a706-cb19363fb9d0\"\n ],\n \"class_session_id\": \"c9697f4a-5152-9d7c-54f5-eb0608792452\",\n \"self_reschedule_count\": 2990146,\n \"location_id\": \"21639d60-ac5f-a078-fba3-08e87895e31a\",\n \"participants\": [\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n },\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"1973-08-25T04:18:54.293Z\",\n \"updated_at\": \"2016-03-23T07:40:15.739Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cde9f15-744f-54ff-901e-bb05d8b9aefe", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5836178-1f6e-5013-bef8-d21b7bfb97e4", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13654917-eaf9-5d10-a0e0-c03156ea1ca2", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4ac989f-85ab-57c5-a14d-4560684268b0", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68695aad-ac2a-5bff-9bf9-6fea5e6eace1", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26397d24-df7a-5119-8778-074e02d60f66", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"start_at\": \"1946-10-13T11:34:15.009Z\",\n \"clinician_id\": \"urn:uuid:52b0216d-7a5e-8d62-eb0b-36167b0e38ff\",\n \"venue_type\": \"mobile_clinic\",\n \"urgency_level\": \"normal\",\n \"patient_notes\": \"reprehenderit velit culpa\",\n \"clinic_notes\": \"reprehenderit ipsum\",\n \"symptoms_description\": \"veniam Excepteur in tempor\",\n \"status\": \"confirmed\",\n \"email_notifications\": true,\n \"sms_notifications\": true,\n \"voice_notifications\": false,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af19eeb8-365c-5ba9-afa1-e85d8c8eb23d", "name": "Cancel an appointment. The only route that may set status=cancelled.", "request": { "name": "Cancel an appointment. The only route that may set status=cancelled.", "description": {}, "url": { "path": [ "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "936c59ff-6f4a-5b59-9c62-ce5a9fc23bbe", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"95603f3b-6776-8a57-218c-2b1b2d62581a\",\n \"status\": \"in_progress\",\n \"patient_id\": \"5d07b3ef-3024-28e2-c14b-ebc3bd51bac2\",\n \"service_id\": \"5261b8a4-c950-6771-a773-0567c7bde80e\",\n \"clinician_id\": \"urn:uuid:6b30c321-35a3-3a38-1200-04ec69d4283f\",\n \"start_at\": \"1969-08-12T06:28:11.510Z\",\n \"end_at\": \"1979-06-29T20:19:51.904Z\",\n \"duration_minutes\": 76956243,\n \"timezone\": \"nulla Excepteur do officia sed\",\n \"venue_type\": \"null\",\n \"venue_details\": {},\n \"booking_source\": \"esse\",\n \"patient_notes\": \"nostrud veniam qui\",\n \"clinic_notes\": \"sit\",\n \"symptoms_description\": \"aute Duis officia aliqui\",\n \"urgency_level\": \"low\",\n \"ai_category\": \"eiusmod do id\",\n \"ai_priority_score\": 51950229.19215262,\n \"ai_suggested_duration\": 44670390.244573355,\n \"predicted_show_probability\": -14063833.700492978,\n \"confirmation_sent_at\": \"1981-08-26T20:58:05.417Z\",\n \"confirmation_method\": \"eiusmod incididunt\",\n \"reminder_sent_at\": \"2021-09-24T18:31:46.973Z\",\n \"reminder_method\": \"minim comm\",\n \"reminder_sent\": false,\n \"payment_status\": \"waived\",\n \"payment_method\": \"esse consectetur labore\",\n \"payment_amount\": 48946552.723646164,\n \"payment_due_date\": \"1960-07-10\",\n \"amount_paid\": -35730977.03047097,\n \"payment_id\": \"ad adipisicing\",\n \"confirmation_code\": \"aliqua qui nostrud\",\n \"cancellation_reason\": \"sint in quis qui eu\",\n \"cancelled_at\": \"1967-11-29T12:59:52.170Z\",\n \"completed_at\": \"2010-12-03T10:11:31.030Z\",\n \"is_group_appointment\": false,\n \"max_participants\": -95633956,\n \"group_name\": \"Duis voluptate culpa\",\n \"recurrence_pattern_id\": \"urn:uuid:0d09a7fa-7bad-1292-ecc9-3e63cb829536\",\n \"series_id\": \"f1e55e66-9595-c9a9-567d-ef2d5ea547c0\",\n \"series_index\": 29835878,\n \"email_notifications\": true,\n \"sms_notifications\": false,\n \"voice_notifications\": true,\n \"notes_session_ids\": [\n \"0ce27eef-4f34-07fa-6d63-6a6fbed933fa\",\n \"7e8b59a1-6e8f-bda0-a706-cb19363fb9d0\"\n ],\n \"class_session_id\": \"c9697f4a-5152-9d7c-54f5-eb0608792452\",\n \"self_reschedule_count\": 2990146,\n \"location_id\": \"21639d60-ac5f-a078-fba3-08e87895e31a\",\n \"participants\": [\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n },\n {\n \"patient_id\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n ],\n \"created_at\": \"1973-08-25T04:18:54.293Z\",\n \"updated_at\": \"2016-03-23T07:40:15.739Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fd550c3-1b44-53d0-b657-9ccd00cb9747", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8564395-d974-520b-b781-738ea0a957d2", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f63301-9eaf-5a43-bf87-c1906d24b9de", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f352ce5-3dab-5627-a812-da9c90580520", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0240879-cb4f-53b4-bdac-1d9f5efed95a", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09cc8837-7bf7-5b08-97be-677a590fab2d", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "appointments", ":appointment_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "appointment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"aliquip Excepteur nulla irure\",\n \"notify_patient\": true,\n \"run_automations\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c9ff8b4b-03e8-50d4-b862-047389d920b1", "name": "Events", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b0f614c6-a8af-5905-bba0-bee04eff7758", "name": "The clinic's own change feed — catch-up for a partner whose webhook endpoint was down.", "request": { "name": "The clinic's own change feed — catch-up for a partner whose webhook endpoint was down.", "description": { "content": "Authorizes via the same scope-less /v1/me shape; filters to event types whose required_scope the key's CURRENT scopes cover.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "after_seq", "value": "0" }, { "disabled": false, "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1ad8efa9-348e-53bd-bbee-15ed7a06d55d", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after_seq", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"events\": [\n {\n \"id\": \"Duis\",\n \"type\": \"minim aliquip laboris sint\",\n \"seq\": -21469855,\n \"clinic_id\": \"6fac4064-67bd-e190-2f24-f8db108e866d\",\n \"subject_id\": \"sunt magna est fugiat\",\n \"data\": {},\n \"created_at\": \"2006-07-05T11:38:30.564Z\"\n },\n {\n \"id\": \"ut ven\",\n \"type\": \"dolore fu\",\n \"seq\": 53587732,\n \"clinic_id\": \"29564410-9091-9b1b-55ee-cdb828bed191\",\n \"subject_id\": \"non sit\",\n \"data\": {},\n \"created_at\": \"2010-07-28T12:14:37.601Z\"\n }\n ],\n \"next_after\": -88443770\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cc75037-7a84-5c2a-b59c-b2f82e239bb6", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after_seq", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42eeb32a-27ad-513d-bbe6-8d20eb2b08a5", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after_seq", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dc286e4-ed7e-5508-9a0c-bea335c09102", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after_seq", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e756ea72-34db-529f-af45-ebc948266aa4", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after_seq", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddacafaf-026f-5859-88d3-16fe2f8681a0", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after_seq", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "755c4e53-06fb-5f74-bf91-3b27a1bcab7b", "name": "Drug requests", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3020fffd-7ee2-52b8-8df7-5ed7c19d279b", "name": "List drug requests sent to this clinic. An org-owned key sees only requests ITS OWN connection created.", "request": { "name": "List drug requests sent to this clinic. An org-owned key sees only requests ITS OWN connection created.", "description": { "content": "No route here lets a requester accept, mark ready, or dispense — those are staff-only, in the app.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "substituted" }, { "disabled": false, "key": "limit", "value": "20" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6a317851-0708-5da6-b534-90737fe36285", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "substituted" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:3ca567c4-ee6a-19be-f5f5-9e362f2c43b1\",\n \"clinic_patient_id\": \"a8a8cff2-7fea-a955-e72f-a0173449d221\",\n \"status\": \"null\",\n \"requester_reference\": \"nulla ea\",\n \"authorization_reference\": \"qui in\",\n \"needed_by\": \"2022-05-19T08:12:56.421Z\",\n \"pharmacist_note\": \"nisi sint Excepteur\",\n \"decline_reason\": \"laboris eu sunt\",\n \"cancel_reason\": \"fugiat dolore\",\n \"cancelled_by_actor\": \"aliquip adipisicing Lorem\",\n \"decided_at\": \"2025-07-21T16:15:53.632Z\",\n \"ready_at\": \"2015-04-27T19:13:35.390Z\",\n \"dispensed_at\": \"1987-05-18T22:04:07.838Z\",\n \"cancelled_at\": \"1969-09-27T09:17:49.806Z\",\n \"expired_at\": \"2016-10-02T06:20:57.886Z\",\n \"created_at\": \"2002-11-28T11:51:44.671Z\",\n \"updated_at\": \"1970-01-26T14:05:38.594Z\",\n \"lines\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"urn:uuid:e4583d80-95e3-be2f-bb99-d46459ada887\",\n \"clinic_patient_id\": \"720bceb7-1745-120e-fb98-19dca54c9330\",\n \"status\": \"declined\",\n \"requester_reference\": \"qui culpa do ani\",\n \"authorization_reference\": \"ex id\",\n \"needed_by\": \"2002-02-02T06:33:48.134Z\",\n \"pharmacist_note\": \"proident \",\n \"decline_reason\": \"officia nulla\",\n \"cancel_reason\": \"sunt Excepteur do sed\",\n \"cancelled_by_actor\": \"sint\",\n \"decided_at\": \"1963-02-03T04:46:15.514Z\",\n \"ready_at\": \"1984-10-13T22:27:39.669Z\",\n \"dispensed_at\": \"1984-08-19T13:41:06.541Z\",\n \"cancelled_at\": \"1981-11-08T05:38:53.264Z\",\n \"expired_at\": \"1994-09-17T22:37:46.991Z\",\n \"created_at\": \"2021-06-08T03:40:07.473Z\",\n \"updated_at\": \"2019-07-17T11:24:43.843Z\",\n \"lines\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"magna laboris proident\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c0223a5-1a24-569f-b1db-b4935b9f476d", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "substituted" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25c6c1ce-4dc1-518e-a3c3-defe92f2d4ee", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "substituted" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "422da39d-3222-551f-898d-5cc736c0e3ea", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "substituted" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "163f4bfe-6f38-5278-a336-c941d3a57619", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "substituted" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67779cf6-0ed8-5fa0-835d-292e8568425e", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "substituted" }, { "key": "limit", "value": "20" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ce1aa79-213a-5e58-bccd-22261639967e", "name": "Send a drug request for a linked enrollee. The pharmacist decides; dispensing happens at the till only.", "request": { "name": "Send a drug request for a linked enrollee. The pharmacist decides; dispensing happens at the till only.", "description": { "content": "clinic_patient_id must already be a patient of this clinic. needed_by defaults to now()+7 days when absent. No price/cost/amount field exists anywhere on this resource.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e50d3387-abc5-5706-bdf1-f5b29d11b07a", "name": "OK. The response does not include `lines` (a stated adapter-level gap — call GET to read them back).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:739b0dc2-0968-7324-74e5-1c5b307c8559\",\n \"clinic_patient_id\": \"urn:uuid:be33c115-0429-a9b8-9692-2c110ee968bf\",\n \"status\": \"partly_accepted\",\n \"requester_reference\": \"cupidatat\",\n \"authorization_reference\": \"qui id consectetur occaecat irure\",\n \"needed_by\": \"1983-09-30T06:34:09.556Z\",\n \"pharmacist_note\": \"Excepteur ullamco eiusmod aliquip sint\",\n \"decline_reason\": \"nulla mollit\",\n \"cancel_reason\": \"tempor ut eiusmod laborum\",\n \"cancelled_by_actor\": \"mollit\",\n \"decided_at\": \"1962-05-11T10:06:27.144Z\",\n \"ready_at\": \"1998-09-07T09:40:46.169Z\",\n \"dispensed_at\": \"1984-12-03T21:36:02.820Z\",\n \"cancelled_at\": \"2013-07-17T12:39:29.069Z\",\n \"expired_at\": \"2003-06-28T23:29:39.445Z\",\n \"created_at\": \"1951-10-22T04:39:39.474Z\",\n \"updated_at\": \"1976-01-06T07:56:35.613Z\",\n \"lines\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5f2bfe7-1030-5898-9dad-b21bfee9865e", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "018fb5d5-7502-599f-84d9-3404287ef801", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "951b681f-0ef5-5986-9d88-6565a1b9e399", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67147e99-e86b-5c74-b533-855ba7060fa3", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f50bd806-a9ed-5433-ae26-152416a79b5d", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecfe3b57-e59b-5d99-a666-bd0d0633fa72", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clinic_patient_id\": \"urn:uuid:714d2cfb-7bb0-59f6-6a41-caf54f1a636b\",\n \"lines\": [\n {\n \"quantity\": 32116816.38275286,\n \"code_system\": \"rxcui\",\n \"code_value\": \"aliquip ut\",\n \"description\": \"labore do Ut\",\n \"directions\": \"Ut exercitation in\"\n }\n ],\n \"requester_reference\": \"adipisicing exercitation ex do laborum\",\n \"authorization_reference\": \"ullamco\",\n \"needed_by\": \"1965-01-05T08:25:20.693Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16bdc79a-323c-5859-a257-d9cfc2c1dcd1", "name": "Get one drug request by id, including its lines.", "request": { "name": "Get one drug request by id, including its lines.", "description": { "content": "A request outside this key's org (or clinic), or absent, answers not_found — identical, one message.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "drug_requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "723d9b25-d24e-5a4b-8da0-4275d119790c", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:739b0dc2-0968-7324-74e5-1c5b307c8559\",\n \"clinic_patient_id\": \"urn:uuid:be33c115-0429-a9b8-9692-2c110ee968bf\",\n \"status\": \"partly_accepted\",\n \"requester_reference\": \"cupidatat\",\n \"authorization_reference\": \"qui id consectetur occaecat irure\",\n \"needed_by\": \"1983-09-30T06:34:09.556Z\",\n \"pharmacist_note\": \"Excepteur ullamco eiusmod aliquip sint\",\n \"decline_reason\": \"nulla mollit\",\n \"cancel_reason\": \"tempor ut eiusmod laborum\",\n \"cancelled_by_actor\": \"mollit\",\n \"decided_at\": \"1962-05-11T10:06:27.144Z\",\n \"ready_at\": \"1998-09-07T09:40:46.169Z\",\n \"dispensed_at\": \"1984-12-03T21:36:02.820Z\",\n \"cancelled_at\": \"2013-07-17T12:39:29.069Z\",\n \"expired_at\": \"2003-06-28T23:29:39.445Z\",\n \"created_at\": \"1951-10-22T04:39:39.474Z\",\n \"updated_at\": \"1976-01-06T07:56:35.613Z\",\n \"lines\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "294b9a86-98fb-5b8c-ae05-d91813c04250", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d67f7aae-8e5e-52bc-9ae6-16adb95526ef", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3923edac-1641-51ce-94ea-8cb956ddbc85", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c65f4c63-2a01-5eaf-8c07-3b18cdec472b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9be0397a-d3cf-5818-a1a2-e3ddb3651922", "name": "Cancel a drug request. Never available once dispensed.", "request": { "name": "Cancel a drug request. Never available once dispensed.", "description": { "content": "Refused with invalid_status_transition (409) when the current status does not allow a requester cancel.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "893586c7-66fe-5479-9f02-220749aa9027", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:739b0dc2-0968-7324-74e5-1c5b307c8559\",\n \"clinic_patient_id\": \"urn:uuid:be33c115-0429-a9b8-9692-2c110ee968bf\",\n \"status\": \"partly_accepted\",\n \"requester_reference\": \"cupidatat\",\n \"authorization_reference\": \"qui id consectetur occaecat irure\",\n \"needed_by\": \"1983-09-30T06:34:09.556Z\",\n \"pharmacist_note\": \"Excepteur ullamco eiusmod aliquip sint\",\n \"decline_reason\": \"nulla mollit\",\n \"cancel_reason\": \"tempor ut eiusmod laborum\",\n \"cancelled_by_actor\": \"mollit\",\n \"decided_at\": \"1962-05-11T10:06:27.144Z\",\n \"ready_at\": \"1998-09-07T09:40:46.169Z\",\n \"dispensed_at\": \"1984-12-03T21:36:02.820Z\",\n \"cancelled_at\": \"2013-07-17T12:39:29.069Z\",\n \"expired_at\": \"2003-06-28T23:29:39.445Z\",\n \"created_at\": \"1951-10-22T04:39:39.474Z\",\n \"updated_at\": \"1976-01-06T07:56:35.613Z\",\n \"lines\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6744046-b430-5884-836d-135f18940275", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b06ffb34-10c0-518e-b9f9-699ca0af9319", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06562ccf-8dfe-5c52-a6ac-8ad52fd4c279", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40061bd3-0a07-54cd-bfdb-189473166e94", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1303550a-775a-5626-b2da-f3f950086372", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "040302a7-0b4a-55a3-b076-c57f978bd6e6", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"quis ullamco\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b91b0d33-c9e6-549f-bd44-057cd5bdc5af", "name": "Accept or decline a pharmacist-proposed substitute. Only valid from status=substituted.", "request": { "name": "Accept or decline a pharmacist-proposed substitute. Only valid from status=substituted.", "description": { "content": "Declining ends the whole request (declined) — the requester may submit a new request rather than looping back to submitted.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "65888543-8377-5229-baee-53c3cccf769f", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:739b0dc2-0968-7324-74e5-1c5b307c8559\",\n \"clinic_patient_id\": \"urn:uuid:be33c115-0429-a9b8-9692-2c110ee968bf\",\n \"status\": \"partly_accepted\",\n \"requester_reference\": \"cupidatat\",\n \"authorization_reference\": \"qui id consectetur occaecat irure\",\n \"needed_by\": \"1983-09-30T06:34:09.556Z\",\n \"pharmacist_note\": \"Excepteur ullamco eiusmod aliquip sint\",\n \"decline_reason\": \"nulla mollit\",\n \"cancel_reason\": \"tempor ut eiusmod laborum\",\n \"cancelled_by_actor\": \"mollit\",\n \"decided_at\": \"1962-05-11T10:06:27.144Z\",\n \"ready_at\": \"1998-09-07T09:40:46.169Z\",\n \"dispensed_at\": \"1984-12-03T21:36:02.820Z\",\n \"cancelled_at\": \"2013-07-17T12:39:29.069Z\",\n \"expired_at\": \"2003-06-28T23:29:39.445Z\",\n \"created_at\": \"1951-10-22T04:39:39.474Z\",\n \"updated_at\": \"1976-01-06T07:56:35.613Z\",\n \"lines\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"line_no\": {\n \"value\": \"\"\n },\n \"code_system\": {\n \"value\": \"\"\n },\n \"code_value\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"directions\": {\n \"value\": \"\"\n },\n \"matched_inventory_item_id\": {\n \"value\": \"\"\n },\n \"matched_medicine_index_id\": {\n \"value\": \"\"\n },\n \"line_status\": {\n \"value\": \"\"\n },\n \"substituted_item_id\": {\n \"value\": \"\"\n },\n \"substitution_reason\": {\n \"value\": \"\"\n },\n \"decline_reason\": {\n \"value\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a39ddda4-0add-5b78-8d64-957eb394438c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14aa5921-f46f-5fb2-9ed5-1dddce2263df", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fc30414-00d1-5ac1-a049-9035bd814ec2", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a2ee001-e1be-5557-bf68-09f637611173", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2e22881-647f-5f04-a4bc-7f6e89146b89", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fa268c5-5788-5236-89b3-08777b25eb84", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "drug_requests", ":request_id", "confirm_substitution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"accept\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "18fa8989-1fdb-5995-a7fd-f44ecdf9668f", "name": "Conditions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fb0b62e0-9813-5036-852a-14db6ce6a98f", "name": "List one patient's conditions (the confirmed problem list, or what this key submitted).", "request": { "name": "List one patient's conditions (the confirmed problem list, or what this key submitted).", "description": { "content": "`patient_id` is required. `review_status` picks the view: `confirmed` (default) is the clinic's own problem list; `pending` is this key's own submissions still waiting for a clinician (and those a clinician rejected); `all` is both. A key never sees another party's submissions. A restricted patient's conditions are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 Condition resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "review_status", "value": "confirmed" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5c60a109-7319-5092-b026-3c34309a87e2", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:b5db30fd-84bc-20e0-89d1-f4438e9c45b9\",\n \"patient_id\": \"urn:uuid:51c81f76-9b63-fae9-ee56-581f18250a71\",\n \"title\": \"quis elit id culpa dolor\",\n \"clinical_status\": \"entered_in_error\",\n \"verification_status\": \"unconfirmed\",\n \"review_status\": \"confirmed\",\n \"code\": {\n \"value\": \"\"\n },\n \"onset_date\": \"2006-01-30\",\n \"resolved_date\": \"2021-07-05\",\n \"notes\": \"aliqua in et ipsum irure\",\n \"recorded_by\": \"38121e77-e5bb-02e2-c015-eeb689fa81ce\",\n \"source\": \"clinic\",\n \"origin_assistant_name\": \"exercitation quis Excepteur adipisicing\",\n \"accepted_by\": \"null\",\n \"reviewed_at\": \"1964-10-10T12:32:49.440Z\",\n \"reviewed_by_staff_id\": \"15eb55e1-9ddc-e0b5-541d-437a66be00f5\",\n \"submission_id\": \"urn:uuid:904842e1-143d-e7b1-e578-72a2caa86d4f\",\n \"decision_reason\": \"ea dolor\",\n \"created_at\": \"2003-05-11T18:33:14.638Z\",\n \"updated_at\": \"1996-01-11T23:38:57.976Z\"\n },\n {\n \"id\": \"urn:uuid:1f02beae-d57b-a92a-7076-1dd41c7906f1\",\n \"patient_id\": \"83f2d5a2-9569-66cc-7e77-2b87e5c80ec1\",\n \"title\": \"id dolor qui\",\n \"clinical_status\": \"resolved\",\n \"verification_status\": \"confirmed\",\n \"review_status\": \"pending\",\n \"code\": {\n \"value\": \"\"\n },\n \"onset_date\": \"2000-02-13\",\n \"resolved_date\": \"1962-10-08\",\n \"notes\": \"fugiat consequat\",\n \"recorded_by\": \"d328f1df-3d40-5479-ea11-98b8009b9cfd\",\n \"source\": \"api\",\n \"origin_assistant_name\": \"nisi officia tempor\",\n \"accepted_by\": \"null\",\n \"reviewed_at\": \"1992-01-17T04:44:54.861Z\",\n \"reviewed_by_staff_id\": \"b2785f22-da61-6e0f-8fcf-488a3bd1f081\",\n \"submission_id\": \"321d1984-8199-b2fe-168e-292c9704b75a\",\n \"decision_reason\": \"quis\",\n \"created_at\": \"1996-11-19T13:13:49.695Z\",\n \"updated_at\": \"1958-09-21T14:36:44.803Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"nisi voluptate\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4761bdfa-ead1-54be-8c75-ce7008a7a479", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e4ef2f0-de5e-5231-80b9-24b9f2a20cbd", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab25bc0a-8375-5b36-9199-67160230c1e5", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70fe5fb3-4418-59ff-a9c5-e57fe42d1c82", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f84c855-6848-5668-b914-61141c6f5ad8", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2067d5c-f731-5145-89ef-a9fe80b01efb", "name": "Submit a condition for a clinician to confirm.", "request": { "name": "Submit a condition for a clinician to confirm.", "description": { "content": "The condition is held for review and answers 202 Accepted with a `Location` header pointing at the submission; it is not in the problem list until a clinician confirms it. The `Idempotency-Key` header is REQUIRED — a retry with the same key returns the original submission, never a second one. Send `client_reference` to tie the record to your own id. Also accepts a FHIR R4 Condition body (`Content-Type: application/fhir+json`).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5ecb0798-a1ae-5c3c-9801-652acb2bf242", "name": "Accepted — waiting for a clinician. If the clinic has chosen to accept this kind of item from your key or connection without review, the body already shows `review_status: confirmed` and `accepted_automatically: true`; read `review_status`, not the status code.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `…/submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"ff4ed4a9-fd4a-13dd-519e-a38c908a51c8\",\n \"patient_id\": \"1c7af6a1-f6c9-9ce7-2269-781f7ad3501e\",\n \"resource_type\": \"referral\",\n \"action\": \"retract\",\n \"review_status\": \"rejected\",\n \"target_id\": \"6e4c2976-34bf-f1fb-d82f-2c2e58d103de\",\n \"accepted_automatically\": true,\n \"source\": \"api\",\n \"submitted_at\": \"2025-08-26T09:02:43.307Z\",\n \"decided_at\": \"1970-11-11T21:32:11.525Z\",\n \"decision_reason\": \"amet\",\n \"result_record_id\": \"a93afcc9-b0ba-1fea-fcd6-a975a29193e6\",\n \"client_reference\": \"sed aliqua Excepteur\",\n \"origin_assistant_name\": \"sint velit cupidatat ut\",\n \"payload\": {}\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "811cc28e-3f17-5a7f-9c50-df71478dfd22", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e0fabb5-ad77-530d-aec5-e961b9583f3d", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35558304-da2e-552b-a1d3-fe43870806ec", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ae48840-661c-58a0-b9dc-7389bfb93b98", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50adc049-337a-547e-b1f7-94a2d60803d2", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8af76cbc-004c-5d13-aded-cc1c3efc3112", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:1ad6f8d4-1fdc-499c-54d4-1d3e76891934\",\n \"title\": \"magna cillum eu\",\n \"code\": \"proident a\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"2007-06-06\",\n \"resolved_date\": \"1958-12-10\",\n \"notes\": \"ut do minim\",\n \"client_reference\": \"aliqua nisi velit lab\",\n \"origin_assistant_name\": \"in dolor dolore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71c1c3ba-36f8-567e-a10f-72ee47846852", "name": "Get one condition from the problem list.", "request": { "name": "Get one condition from the problem list.", "description": { "content": "With `Accept: application/fhir+json` the answer is a FHIR R4 Condition.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "37b89441-4337-588e-ae5d-6dc8a5e75560", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"95d1165f-e126-c0ec-8aa6-cf1040063174\",\n \"patient_id\": \"urn:uuid:972f2eb5-afb7-7f78-77e5-342c6b86f159\",\n \"title\": \"irure dolor magna\",\n \"clinical_status\": \"active\",\n \"verification_status\": \"unconfirmed\",\n \"review_status\": \"confirmed\",\n \"code\": {\n \"system\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"onset_date\": \"1948-06-02\",\n \"resolved_date\": \"1995-01-07\",\n \"notes\": \"sit ad\",\n \"recorded_by\": \"urn:uuid:753546d0-0bed-a99d-8732-0efdefadd1a0\",\n \"source\": \"api\",\n \"origin_assistant_name\": \"magna proident esse aute aliqua\",\n \"accepted_by\": \"null\",\n \"reviewed_at\": \"1970-03-01T07:39:55.301Z\",\n \"reviewed_by_staff_id\": \"urn:uuid:6ce383be-26e6-7b0f-a720-c015c04a1577\",\n \"submission_id\": \"daf438a7-934a-f06b-57a0-577446e559c6\",\n \"decision_reason\": \"eu qui ipsum\",\n \"created_at\": \"2001-03-07T04:20:40.606Z\",\n \"updated_at\": \"1963-08-11T11:10:03.244Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a84c42c7-543e-5eac-9dc5-d8318ecfe60d", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ddf9310-57dd-5e6e-8661-ab4c58ab5389", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b4582a6-48c2-5103-b7b7-138a1af10b4b", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2079a8e-1d6d-5256-ab2f-26aa399cb8f5", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23452dd3-1211-5b64-ae63-674741b328dd", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15016ebe-7f12-54e2-ba74-e651dd29c959", "name": "Propose a change to a condition, or retract it.", "request": { "name": "Propose a change to a condition, or retract it.", "description": { "content": "The change is held for a clinician to confirm and answers 202 Accepted with a `Location` header pointing at the new submission; the problem-list entry is unchanged until then. `clinical_status: entered_in_error` proposes a retraction. The `Idempotency-Key` header is optional. Also accepts a FHIR R4 Condition body (`Content-Type: application/fhir+json`).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dcda4d3b-1191-5dc0-a267-bac57b3ff72c", "name": "Accepted — waiting for a clinician.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `…/submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"urn:uuid:140ba025-8b3f-4fb7-83e7-0c2953e30156\",\n \"patient_id\": \"urn:uuid:6032b270-5e66-5027-05b3-a77210edf04b\",\n \"resource_type\": \"referral\",\n \"action\": \"create\",\n \"review_status\": \"rejected\",\n \"target_id\": \"3be34e56-8619-ba31-6b31-c30460cc3d48\",\n \"accepted_automatically\": false,\n \"source\": \"api\",\n \"submitted_at\": \"1976-05-30T06:23:30.572Z\",\n \"decided_at\": \"2017-12-31T14:18:24.968Z\",\n \"decision_reason\": \"dolore\",\n \"result_record_id\": \"4981580a-a08e-f113-13f8-e2ac4023a022\",\n \"client_reference\": \"Excepteur ut consequat\",\n \"origin_assistant_name\": \"magna velit nostrud Excepteur\",\n \"payload\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3975560-6f2a-52df-98a6-622826c5af45", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c53cb217-5511-5f86-bf18-30e9fbac9c2d", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0511662-5ecd-5559-a080-009071c62f46", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "818f0e8c-4af6-5352-a38c-3bb871c819b8", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e12a7f2-57b6-5620-9807-b8e198df900a", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2a03ba0-bb6c-558c-9ff3-a80fb2321f72", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "conditions", ":condition_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "condition_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"laboris Ut dolore\",\n \"code\": \"aliquip officia exercitation\",\n \"code_system\": \"local\",\n \"clinical_status\": \"active\",\n \"onset_date\": \"1996-12-17\",\n \"resolved_date\": \"1998-01-29\",\n \"notes\": \"cupidatat aute voluptate\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ad53f512-33dd-5b27-9f07-a3e636d63988", "name": "Allergies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a5f1cbfa-0bb3-5fd8-84e6-84d87e843e9b", "name": "List one patient's allergies (the confirmed chart, or what this key submitted).", "request": { "name": "List one patient's allergies (the confirmed chart, or what this key submitted).", "description": { "content": "`patient_id` is required. `review_status` picks the view: `confirmed` (default) is the clinic's own allergy list; `pending` is this key's own submissions still waiting for a clinician (and those a clinician rejected); `all` is both. `clinical_status` filters the confirmed records. The confirmed list also includes allergies that are only a name on the clinic's simple allergy list, as `entry: legacy_text` items with no id. An empty list does NOT mean \"no known allergies\". A restricted patient's allergies are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 AllergyIntolerance resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "review_status", "value": "confirmed" }, { "disabled": false, "key": "clinical_status", "value": "resolved" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bcf31ea5-6122-5c45-8939-65991d68c785", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "clinical_status", "value": "resolved" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:81d722f9-8944-7f0c-3685-e8e019d14f6d\",\n \"patient_id\": \"urn:uuid:576e5a19-64a2-cb73-de44-665ab87a455e\",\n \"entry\": \"structured\",\n \"substance\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"verification_status\": \"refuted\",\n \"review_status\": \"pending\",\n \"category\": [\n \"biologic\",\n \"biologic\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"null\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"onset_date\": \"2011-01-07\",\n \"note\": \"aliquip eiusmod non\",\n \"recorded_by\": \"urn:uuid:823b99fc-103a-85c9-cc96-d7d5653afe9d\",\n \"source\": \"clinic\",\n \"origin_assistant_name\": \"elit ullam\",\n \"accepted_by\": \"null\",\n \"reviewed_at\": \"2006-06-12T09:34:30.485Z\",\n \"reviewed_by_staff_id\": \"urn:uuid:9c35d085-6af4-600d-15cb-7da91146424c\",\n \"submission_id\": \"urn:uuid:1eeb9211-62cd-3858-2d0e-d3a4858e0061\",\n \"decision_reason\": \"fugiat\",\n \"created_at\": \"2002-12-05T17:51:03.216Z\",\n \"updated_at\": \"2009-07-01T08:28:11.626Z\"\n },\n {\n \"id\": \"urn:uuid:774defbc-e6fe-3b0f-27c4-0120264ea3de\",\n \"patient_id\": \"4c58eb0f-d419-a187-557a-9d6b8b191836\",\n \"entry\": \"structured\",\n \"substance\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"verification_status\": \"entered_in_error\",\n \"review_status\": \"withdrawn\",\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"onset_date\": \"1983-04-15\",\n \"note\": \"esse mollit officia dolor\",\n \"recorded_by\": \"dbf8de47-027b-c632-f02d-08720d910248\",\n \"source\": \"api\",\n \"origin_assistant_name\": \"minim reprehenderit nostrud officia\",\n \"accepted_by\": \"clinic\",\n \"reviewed_at\": \"1991-12-03T18:59:43.306Z\",\n \"reviewed_by_staff_id\": \"urn:uuid:73f6fd20-1629-fb95-4275-06d4ff916c06\",\n \"submission_id\": \"51cd67c0-785a-6e40-9023-789f1b858981\",\n \"decision_reason\": \"consequat velit eiusmod\",\n \"created_at\": \"2006-02-05T12:52:38.919Z\",\n \"updated_at\": \"1950-06-08T00:21:42.343Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"quis sed id\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48fdb7ec-e855-5c50-b8ef-ecb1f03fd03c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "clinical_status", "value": "resolved" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36bfa673-1643-5f26-9fda-a6597cf42dd4", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "clinical_status", "value": "resolved" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "940d7459-7db1-5561-8963-52392a9ef476", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "clinical_status", "value": "resolved" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b91cfb-dd37-5f7d-b009-b523e199ed48", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "clinical_status", "value": "resolved" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "080387e7-d23b-55f8-8f9e-90cf24d836bd", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "clinical_status", "value": "resolved" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0c5f49c-e658-5adb-a18f-0dbb14e6f25e", "name": "Submit an allergy for a clinician to confirm.", "request": { "name": "Submit an allergy for a clinician to confirm.", "description": { "content": "The allergy is held for review and answers 202 Accepted with a `Location` header pointing at the submission; it is not on the chart until a clinician confirms it. The `Idempotency-Key` header is REQUIRED - a retry with the same key returns the original submission, never a second one. An allergy the patient already has is not refused: it is held for a clinician like any other, who rejects the duplicate. JSON only: a FHIR AllergyIntolerance body is not accepted.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a33104cb-5be2-5aec-afac-9eefd37882d3", "name": "Accepted - waiting for a clinician. If the clinic has chosen to accept this kind of item from your key or connection without review, the body already shows `review_status: confirmed` and `accepted_automatically: true`; read `review_status`, not the status code.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `.../submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"ff4ed4a9-fd4a-13dd-519e-a38c908a51c8\",\n \"patient_id\": \"1c7af6a1-f6c9-9ce7-2269-781f7ad3501e\",\n \"resource_type\": \"referral\",\n \"action\": \"retract\",\n \"review_status\": \"rejected\",\n \"target_id\": \"6e4c2976-34bf-f1fb-d82f-2c2e58d103de\",\n \"accepted_automatically\": true,\n \"source\": \"api\",\n \"submitted_at\": \"2025-08-26T09:02:43.307Z\",\n \"decided_at\": \"1970-11-11T21:32:11.525Z\",\n \"decision_reason\": \"amet\",\n \"result_record_id\": \"a93afcc9-b0ba-1fea-fcd6-a975a29193e6\",\n \"client_reference\": \"sed aliqua Excepteur\",\n \"origin_assistant_name\": \"sint velit cupidatat ut\",\n \"payload\": {}\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f261ec4-e05e-561d-9c60-20387db0351e", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5270e170-39a7-5092-8ab1-db9a6ed2aaa0", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67c825b4-6568-5194-b0a7-0cddff33468d", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da105f00-4b7d-5b05-bebb-99c40ae76cd4", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d18a9bbc-320c-5f39-ba74-91e4be2a9a14", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57600fb4-97ab-5f3d-a5fa-9ae27fd86cf0", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"b2c398ee-89b6-5cc7-0912-5bad82d32b66\",\n \"substance\": {\n \"text\": \"quis ad in\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"voluptate proident adipisicing\"\n }\n },\n \"no_known_allergies\": true,\n \"category\": [\n \"environment\",\n \"food\"\n ],\n \"criticality\": \"unable_to_assess\",\n \"type\": \"allergy\",\n \"clinical_status\": \"active\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"deserunt te\"\n ],\n \"severity\": \"moderate\",\n \"description\": \"Lorem enim deserunt ut\"\n },\n {\n \"manifestation\": [\n \"officia minim enim consectetur\"\n ],\n \"severity\": \"mild\",\n \"description\": \"cupidatat pariatur\"\n }\n ],\n \"onset_date\": \"2014-08-05\",\n \"note\": \"voluptate\",\n \"client_reference\": \"Duis\",\n \"origin_assistant_name\": \"cillum ipsum non\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4d1a16a-8908-54e2-9f57-57e3ec9f8017", "name": "Get one allergy from the chart.", "request": { "name": "Get one allergy from the chart.", "description": { "content": "Only a detailed (structured) allergy has an id; an allergy that is only a name on the clinic's simple list is not fetchable by id. With `Accept: application/fhir+json` the answer is a FHIR R4 AllergyIntolerance.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "43a47dfe-0763-567b-913c-9dbd2556693f", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:48db3859-f3a8-42c7-d141-abe912af6b26\",\n \"patient_id\": \"urn:uuid:0dcd7bfa-d0fe-7dc1-6843-9022ebb0ca01\",\n \"entry\": \"no_known_allergies\",\n \"substance\": {\n \"text\": \"pariatur\",\n \"code\": {\n \"value\": \"\"\n }\n },\n \"verification_status\": \"confirmed\",\n \"review_status\": \"pending\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"criticality\": \"low\",\n \"type\": \"null\",\n \"clinical_status\": \"null\",\n \"reactions\": [\n {\n \"manifestation\": {\n \"value\": \"\"\n },\n \"severity\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n {\n \"manifestation\": {\n \"value\": \"\"\n },\n \"severity\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n }\n ],\n \"onset_date\": \"1975-12-20\",\n \"note\": \"anim velit quis pariatur\",\n \"recorded_by\": \"urn:uuid:34378efc-549b-e2d7-5671-70ecc93ea491\",\n \"source\": \"api\",\n \"origin_assistant_name\": \"officia eiusmod\",\n \"accepted_by\": \"null\",\n \"reviewed_at\": \"1994-12-31T22:08:07.873Z\",\n \"reviewed_by_staff_id\": \"68b08235-612f-466a-10dc-6211cb752af2\",\n \"submission_id\": \"3c748cff-fae9-30ab-97dd-97494f151bd7\",\n \"decision_reason\": \"id nisi elit enim\",\n \"created_at\": \"2007-07-21T00:17:37.872Z\",\n \"updated_at\": \"1956-09-13T10:56:40.735Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eab5a6e-c7e1-5bef-ae9f-af2406a5aa21", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d7cebf5-a8ea-5076-95fd-ef3064fcf9f0", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1232974-f289-597d-84df-1d8d3270490a", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39bfefa4-c44f-50d4-873e-74bae71426fe", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "203195d8-2f5a-5da6-8ecc-0c7aed69ad12", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "145cd47b-a47f-51f0-9f4d-5c467915a8d5", "name": "Propose a change to an allergy, or retract it.", "request": { "name": "Propose a change to an allergy, or retract it.", "description": { "content": "The change is held for a clinician to confirm and answers 202 Accepted with a `Location` header pointing at the new submission; the allergy is unchanged until then. `clinical_status: entered_in_error` proposes a retraction. The substance cannot be changed. The `Idempotency-Key` header is optional. JSON only: a FHIR AllergyIntolerance body is not accepted.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ad46bdf5-0e04-54c5-9c71-63459cd2988d", "name": "Accepted - waiting for a clinician.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `.../submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"urn:uuid:140ba025-8b3f-4fb7-83e7-0c2953e30156\",\n \"patient_id\": \"urn:uuid:6032b270-5e66-5027-05b3-a77210edf04b\",\n \"resource_type\": \"referral\",\n \"action\": \"create\",\n \"review_status\": \"rejected\",\n \"target_id\": \"3be34e56-8619-ba31-6b31-c30460cc3d48\",\n \"accepted_automatically\": false,\n \"source\": \"api\",\n \"submitted_at\": \"1976-05-30T06:23:30.572Z\",\n \"decided_at\": \"2017-12-31T14:18:24.968Z\",\n \"decision_reason\": \"dolore\",\n \"result_record_id\": \"4981580a-a08e-f113-13f8-e2ac4023a022\",\n \"client_reference\": \"Excepteur ut consequat\",\n \"origin_assistant_name\": \"magna velit nostrud Excepteur\",\n \"payload\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53a2778d-9cb9-52d2-8fda-d9a7fbfb84df", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28d8037b-7d11-5cda-b1a6-708a00f80fef", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ff40198-cdd0-5f05-ab55-8d4d52b4e325", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28954e01-7797-596b-893b-213c857bf161", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77a8a6ec-fb53-5a98-9feb-d5d82deb0a4c", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a102d59-8249-5abd-94eb-c4419da7dedd", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "allergies", ":allergy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "allergy_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"clinical_status\": \"active\",\n \"criticality\": \"high\",\n \"category\": [\n \"biologic\",\n \"medication\"\n ],\n \"type\": \"intolerance\",\n \"reactions\": [\n {\n \"manifestation\": [\n \"exercitation sint ut\"\n ],\n \"severity\": \"null\",\n \"description\": \"aliquip et cupidatat ullamco\"\n },\n {\n \"manifestation\": [\n \"e\"\n ],\n \"severity\": \"mild\",\n \"description\": \"laborum in incididunt ad\"\n }\n ],\n \"onset_date\": \"1971-05-09\",\n \"note\": \"veniam aute\",\n \"client_reference\": \"laborum aliqua in minim\",\n \"origin_assistant_name\": \"qui dolor et tempor\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8b303963-f13d-5b40-83d0-25c279eb04d9", "name": "Medications", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "50b282d7-c73d-5b80-ac13-f747b33ab6be", "name": "List one patient's reported medicines (the confirmed chart, or what this key submitted).", "request": { "name": "List one patient's reported medicines (the confirmed chart, or what this key submitted).", "description": { "content": "`patient_id` is required. `review_status` picks the view: `confirmed` (default) is the clinic's own list of reported medicines; `pending` is this key's own submissions still waiting for a clinician (and those a clinician rejected); `all` is both. `status` filters by the statement's status. A reported medicine is what the patient says they take; it is not a prescription (see `listPrescriptions`). A restricted patient's statements are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 MedicationStatement resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "review_status", "value": "confirmed" }, { "disabled": false, "key": "status", "value": "active" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2a0fba30-8319-5680-b9da-73834e92744f", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "active" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:ba6b566b-453e-1759-842b-b0fc4e791a76\",\n \"patient_id\": \"dd775833-130f-74a7-ce0d-920b2a85321e\",\n \"medication\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"verification_status\": \"confirmed\",\n \"review_status\": \"withdrawn\",\n \"dosage\": {\n \"text\": {\n \"value\": \"\"\n },\n \"route\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n }\n },\n \"status\": \"stopped\",\n \"effective\": {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n },\n \"reason\": \"eiu\",\n \"note\": \"n\",\n \"recorded_by\": \"1c4141ec-f767-5dcb-219e-55f03a5340a2\",\n \"source\": \"clinic\",\n \"origin_assistant_name\": \"sit occaecat ipsum veniam proident\",\n \"accepted_by\": \"automatic\",\n \"reviewed_at\": \"1984-01-28T06:24:49.153Z\",\n \"reviewed_by_staff_id\": \"47b66430-0161-21f3-e58d-67e8c6d489c9\",\n \"submission_id\": \"087d73d4-6bbf-66ea-1c2c-20f4e2d6334c\",\n \"decision_reason\": \"velit enim\",\n \"created_at\": \"1969-08-12T14:14:04.042Z\",\n \"updated_at\": \"1983-01-25T02:09:03.359Z\"\n },\n {\n \"id\": \"cea8cc09-f5aa-eb1e-c313-8c2f45bdee89\",\n \"patient_id\": \"57d19889-a27e-0fe2-5f56-bef5e89f1cc9\",\n \"medication\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"verification_status\": \"unconfirmed\",\n \"review_status\": \"withdrawn\",\n \"dosage\": {\n \"text\": {\n \"value\": \"\"\n },\n \"route\": {\n \"value\": \"\"\n },\n \"frequency\": {\n \"value\": \"\"\n }\n },\n \"status\": \"stopped\",\n \"effective\": {\n \"start\": {\n \"value\": \"\"\n },\n \"end\": {\n \"value\": \"\"\n }\n },\n \"reason\": \"in dolor velit\",\n \"note\": \"velit\",\n \"recorded_by\": \"e32bc52f-3c7a-8d54-3480-5b876047e555\",\n \"source\": \"clinic\",\n \"origin_assistant_name\": \"Ut do Excepteur exercitation\",\n \"accepted_by\": \"automatic\",\n \"reviewed_at\": \"1947-10-05T23:58:20.406Z\",\n \"reviewed_by_staff_id\": \"c816f483-1b5d-d486-429f-120e8523ed8e\",\n \"submission_id\": \"urn:uuid:09fb2219-fe51-686c-3f4b-7d138ef9fa7e\",\n \"decision_reason\": \"adipisicing mollit aute id\",\n \"created_at\": \"1949-09-30T16:55:31.426Z\",\n \"updated_at\": \"1946-10-23T01:00:48.966Z\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"quis nulla enim sit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc23c94-bd57-5ff8-9d8c-4f46b573a236", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "active" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "412084dd-1553-56ac-be02-9fbdf7864507", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "active" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "212abf08-8c11-5d63-90c2-13a72191b03d", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "active" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e998dca7-bcca-5e0d-82d2-40931d0058b9", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "active" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb0f2ad8-05e1-5019-8a13-53c2bc4a3dea", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "active" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6395736-2b3f-5d7a-83b8-532504b8f095", "name": "Submit a reported medicine for a clinician to confirm.", "request": { "name": "Submit a reported medicine for a clinician to confirm.", "description": { "content": "The statement is held for review and answers 202 Accepted with a `Location` header pointing at the submission; it is not on the chart until a clinician confirms it (unless the clinic has chosen to accept such submissions automatically). The `Idempotency-Key` header is REQUIRED - a retry with the same key returns the original submission, never a second one. This records what the patient reports taking; it does not prescribe or dispense anything. JSON only: a FHIR MedicationStatement body is not accepted.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "856c5bd6-a902-5f6f-b8bb-716e9fec9df8", "name": "Accepted - waiting for a clinician. If the clinic has chosen to accept this kind of item from your key or connection without review, the body already shows `review_status: confirmed` and `accepted_automatically: true`; read `review_status`, not the status code.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `.../submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"ff4ed4a9-fd4a-13dd-519e-a38c908a51c8\",\n \"patient_id\": \"1c7af6a1-f6c9-9ce7-2269-781f7ad3501e\",\n \"resource_type\": \"referral\",\n \"action\": \"retract\",\n \"review_status\": \"rejected\",\n \"target_id\": \"6e4c2976-34bf-f1fb-d82f-2c2e58d103de\",\n \"accepted_automatically\": true,\n \"source\": \"api\",\n \"submitted_at\": \"2025-08-26T09:02:43.307Z\",\n \"decided_at\": \"1970-11-11T21:32:11.525Z\",\n \"decision_reason\": \"amet\",\n \"result_record_id\": \"a93afcc9-b0ba-1fea-fcd6-a975a29193e6\",\n \"client_reference\": \"sed aliqua Excepteur\",\n \"origin_assistant_name\": \"sint velit cupidatat ut\",\n \"payload\": {}\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a02476b-5c39-5bbd-80a6-cd84ea7fdb67", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d72fa188-1bf3-5b00-81df-a4027bde21f3", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a39381f-04c5-52c7-9867-b1ddfda4b085", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1771f20-3cf2-519d-9467-33af15b8f115", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf6886e5-4ed5-5620-9cce-48b505ab0ffb", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3178766-7350-5b10-8e4e-9f217d8fa77f", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:a3f7f109-2d43-1ee2-fbbb-48075be82160\",\n \"medication\": {\n \"text\": \"culpa ipsum\",\n \"code\": {\n \"system\": \"rxnorm\",\n \"code\": \"dese\"\n }\n },\n \"dosage\": {\n \"text\": \"laboris deserunt\",\n \"route\": \"dolore enim\",\n \"frequency\": \"ad non\"\n },\n \"status\": \"active\",\n \"effective_start\": \"1989-01-08\",\n \"effective_end\": \"1991-09-21\",\n \"reason\": \"culpa\",\n \"note\": \"ad aliqua\",\n \"client_reference\": \"velit\",\n \"origin_assistant_name\": \"in in labore in pariatur\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40a05781-0831-552c-8a7d-363c56712261", "name": "Get one reported medicine from the chart.", "request": { "name": "Get one reported medicine from the chart.", "description": { "content": "Only a confirmed statement is fetchable by id. With `Accept: application/fhir+json` the answer is a FHIR R4 MedicationStatement.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "eba938f0-07c0-5014-9d53-dedb8f80a5c9", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"4997d95a-4207-faa6-816f-132843ed0656\",\n \"patient_id\": \"urn:uuid:6eb533fc-9aab-8fb5-f851-e65a3925db55\",\n \"medication\": {\n \"text\": \"in magna amet sint\",\n \"code\": {\n \"value\": \"\"\n }\n },\n \"verification_status\": \"confirmed\",\n \"review_status\": \"pending\",\n \"dosage\": {\n \"text\": \"mollit ullamco enim\",\n \"route\": \"sunt el\",\n \"frequency\": \"quis consectetur enim nisi\"\n },\n \"status\": \"stopped\",\n \"effective\": {\n \"start\": \"1961-06-11\",\n \"end\": \"2018-07-19\"\n },\n \"reason\": \"laboris nostrud\",\n \"note\": \"ea laborum officia nulla deserunt\",\n \"recorded_by\": \"urn:uuid:d1eb142d-f195-02c0-0ad8-2cdb7582b197\",\n \"source\": \"clinic\",\n \"origin_assistant_name\": \"enim ad\",\n \"accepted_by\": \"clinic\",\n \"reviewed_at\": \"1971-12-13T08:52:21.753Z\",\n \"reviewed_by_staff_id\": \"d1286d46-985a-8094-1486-c0b1aef4fc54\",\n \"submission_id\": \"urn:uuid:d1a902a9-baff-c065-1541-251b33182f6e\",\n \"decision_reason\": \"\",\n \"created_at\": \"2021-03-10T20:15:10.961Z\",\n \"updated_at\": \"1996-05-10T09:27:20.355Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e1aa3e7-92f5-5c6a-8855-134430fe963b", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e03c7d6-e3fd-5b71-b100-b0825f5124ab", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8006531f-877d-52ce-8de7-a5b012e43eb5", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3f241f8-83d3-5f76-9e56-d3beec452c8c", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aab32f52-e739-5e01-bbca-9bb228186049", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e7edeba-aa6b-514e-af5a-f1a77d9e3038", "name": "Propose a change to a reported medicine, or retract it.", "request": { "name": "Propose a change to a reported medicine, or retract it.", "description": { "content": "The change is held for a clinician to confirm and answers 202 Accepted with a `Location` header pointing at the new submission; the statement is unchanged until then. A change is always reviewed by a clinician, even when the clinic accepts new reported medicines automatically. `status: entered_in_error` proposes a retraction. The medicine cannot be changed. The `Idempotency-Key` header is optional. JSON only: a FHIR MedicationStatement body is not accepted.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7a2bbf34-db0b-57c0-893a-5392d3ca78e3", "name": "Accepted - waiting for a clinician.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `.../submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"urn:uuid:140ba025-8b3f-4fb7-83e7-0c2953e30156\",\n \"patient_id\": \"urn:uuid:6032b270-5e66-5027-05b3-a77210edf04b\",\n \"resource_type\": \"referral\",\n \"action\": \"create\",\n \"review_status\": \"rejected\",\n \"target_id\": \"3be34e56-8619-ba31-6b31-c30460cc3d48\",\n \"accepted_automatically\": false,\n \"source\": \"api\",\n \"submitted_at\": \"1976-05-30T06:23:30.572Z\",\n \"decided_at\": \"2017-12-31T14:18:24.968Z\",\n \"decision_reason\": \"dolore\",\n \"result_record_id\": \"4981580a-a08e-f113-13f8-e2ac4023a022\",\n \"client_reference\": \"Excepteur ut consequat\",\n \"origin_assistant_name\": \"magna velit nostrud Excepteur\",\n \"payload\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fd0bb45-8b42-5529-9323-d378e63d6e3a", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0effc20f-6c8c-58c2-9392-d8c57467a2af", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fbb4a25-5d3a-55dd-b065-113a5a1ee79e", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "370ed20c-fc60-5897-a8e5-7a009100790c", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c016a2-14d0-549c-a3cc-f57e36e0ea5a", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d01681f4-2636-5ea6-9baf-315b9a036f86", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "medication-statements", ":medication_statement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "medication_statement_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"dosage\": {\n \"text\": \"esse id occaecat Ut\",\n \"route\": \"vel\",\n \"frequency\": \"consectetur exercitation reprehenderit Lorem\"\n },\n \"effective_start\": \"1987-01-19\",\n \"effective_end\": \"1976-03-11\",\n \"reason\": \"elit qui non ea\",\n \"note\": \"est pariatur irure exercitation\",\n \"client_reference\": \"labore aute veniam\",\n \"origin_assistant_name\": \"pariatur consectetur mollit\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fdd7fd2-ec13-5c44-97b3-24072b35d5e6", "name": "List one patient's prescriptions (read only).", "request": { "name": "List one patient's prescriptions (read only).", "description": { "content": "`patient_id` is required. Prescriptions are read only and minimal: the drug, the dose, the frequency, the status and when it was written, with `source` telling a prescription sent through the clinic's e-prescribing connection (`eprescribe`) from one written in the clinic (`clinic`). There is no route to create or change a prescription. `status` filters by the prescription's status. A restricted patient's prescriptions, and any the clinic has marked sensitive, are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 MedicationRequest resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "status", "value": "out_of_stock" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a86c9605-20ab-5ba7-b260-14642f5836f0", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "out_of_stock" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:a99279b0-9260-67c6-e244-58836cf5fe5e\",\n \"patient_id\": \"f7415284-d477-2f6f-cb01-2a14c8ab58cd\",\n \"medication\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"status\": \"out_of_stock\",\n \"source\": \"eprescribe\",\n \"dosage\": \"consectetur cillum\",\n \"frequency\": \"anim dolor deserunt\",\n \"prescribed_at\": \"2023-04-01T16:05:10.077Z\",\n \"updated_at\": \"2002-05-05T19:24:22.890Z\"\n },\n {\n \"id\": \"urn:uuid:77871d3d-8673-b1f7-b5ad-4e0eee44b302\",\n \"patient_id\": \"urn:uuid:f948e656-5ca8-7342-7635-d1af98ba1488\",\n \"medication\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"status\": \"unknown\",\n \"source\": \"eprescribe\",\n \"dosage\": \"dolore incididunt\",\n \"frequency\": \"in ea id\",\n \"prescribed_at\": \"1947-02-06T23:46:04.477Z\",\n \"updated_at\": \"1991-05-03T07:16:44.924Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"ut commodo nisi eu\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ace802a1-c829-54ed-8cf4-eca85f6a319a", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "out_of_stock" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b0ce062-4f72-5e14-a4b8-699a6ef9ac33", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "out_of_stock" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c55ff490-1b9e-516b-9be0-5084656e7002", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "out_of_stock" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "034dcd5b-cfba-50c2-87cf-aa3871fac789", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "out_of_stock" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7d80c7a-8a9d-57b2-8be1-05da90086d62", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "out_of_stock" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7fef828-f0a4-5a63-a565-b4cfc8da170c", "name": "Get one prescription (read only).", "request": { "name": "Get one prescription (read only).", "description": { "content": "The same minimal fields as the list. With `Accept: application/fhir+json` the answer is a FHIR R4 MedicationRequest.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "prescriptions", ":prescription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "prescription_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "178470c5-b1e3-5c3d-af24-08a1e2e7770b", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions", ":prescription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "prescription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:e67dd98e-248f-c066-b579-f2ce6365c490\",\n \"patient_id\": \"01fa7adc-3c33-84db-aebb-b0aa4f70234b\",\n \"medication\": {\n \"name\": \"reprehenderit fugiat\"\n },\n \"status\": \"dispensed\",\n \"source\": \"eprescribe\",\n \"dosage\": \"cillum proident Duis enim\",\n \"frequency\": \"consectetur tempor in incididunt\",\n \"prescribed_at\": \"1972-01-23T01:00:22.407Z\",\n \"updated_at\": \"1971-09-25T16:40:46.139Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffb627c8-189c-555d-a375-14731cb6865c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions", ":prescription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "prescription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113faa28-9bb4-5939-a773-4c127f2057cc", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions", ":prescription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "prescription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fb9d059-098b-5488-a6b0-3929519d5216", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions", ":prescription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "prescription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5911a0ad-d822-5e27-8128-0babf2d2bbcd", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions", ":prescription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "prescription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d85f3d60-278d-5c64-a555-7a09334ea296", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "prescriptions", ":prescription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "prescription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "61e6418e-e504-539b-8c55-c90132bd8eb1", "name": "Referrals", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6bf10553-4164-5382-ace2-d0da0b2ae2a7", "name": "List one patient's clinical referrals (the clinic's list, or what this key submitted).", "request": { "name": "List one patient's clinical referrals (the clinic's list, or what this key submitted).", "description": { "content": "`patient_id` is required. `review_status` picks the view: `confirmed` (default) is the clinic's own referral list for the patient, whoever sent each referral; `pending` is this key's own submissions still waiting for clinic staff (and those staff rejected); `all` is both. `status` filters confirmed referrals by the clinic's workflow state. These are clinical referrals to the clinic; they are not the clinic referral programme. A restricted patient's referrals are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 ServiceRequest resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "review_status", "value": "confirmed" }, { "disabled": false, "key": "status", "value": "received" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ff4cfaf6-7d41-57c7-a92b-79532ec80bdf", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "received" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"92b6a46e-4652-ca44-e0a4-ed0a6e0347d6\",\n \"patient_id\": \"urn:uuid:bbb2ee67-ba8a-9f6f-b0a6-aec408aa2162\",\n \"direction\": \"outgoing\",\n \"status\": \"scheduled\",\n \"service\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"reason\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"review_status\": \"pending\",\n \"priority\": \"null\",\n \"clinical_summary\": \"nostrud\",\n \"requester\": {\n \"name\": {\n \"value\": \"\"\n },\n \"organization\": {\n \"value\": \"\"\n },\n \"npi\": {\n \"value\": \"\"\n }\n },\n \"recipient\": {\n \"provider_id\": {\n \"value\": \"\"\n },\n \"department_id\": {\n \"value\": \"\"\n }\n },\n \"requested_at\": \"1957-11-29T11:48:00.709Z\",\n \"needed_by\": \"1961-11-19\",\n \"scheduled_appointment_id\": \"2fd8aa24-2195-ca83-f443-84d59bb947b6\",\n \"source\": \"api\",\n \"origin_assistant_name\": \"proident laboris ad\",\n \"accepted_by\": \"automatic\",\n \"reviewed_at\": \"1997-04-16T14:41:19.840Z\",\n \"reviewed_by_staff_id\": \"00e7fe25-a858-470a-fb92-fc1848d7053a\",\n \"submission_id\": \"636a6171-cbc4-1328-d12b-eb6b5a343a20\",\n \"decision_reason\": \"Ut Lorem\",\n \"created_at\": \"2004-12-26T11:22:34.869Z\",\n \"updated_at\": \"1954-04-16T17:25:51.747Z\"\n },\n {\n \"id\": \"urn:uuid:6f538a03-9fc6-ddc0-4601-24565df8fb33\",\n \"patient_id\": \"urn:uuid:99102502-8a19-8baa-4c55-2d14d31707a4\",\n \"direction\": \"incoming\",\n \"status\": \"entered_in_error\",\n \"service\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"reason\": {\n \"text\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n },\n \"review_status\": \"confirmed\",\n \"priority\": \"urgent\",\n \"clinical_summary\": \"ex exercitation amet\",\n \"requester\": {\n \"name\": {\n \"value\": \"\"\n },\n \"organization\": {\n \"value\": \"\"\n },\n \"npi\": {\n \"value\": \"\"\n }\n },\n \"recipient\": {\n \"provider_id\": {\n \"value\": \"\"\n },\n \"department_id\": {\n \"value\": \"\"\n }\n },\n \"requested_at\": \"1975-07-11T08:57:53.414Z\",\n \"needed_by\": \"1984-07-01\",\n \"scheduled_appointment_id\": \"urn:uuid:21b891da-1fbc-31e3-1d16-a6d01744fafc\",\n \"source\": \"null\",\n \"origin_assistant_name\": \"id sunt a\",\n \"accepted_by\": \"automatic\",\n \"reviewed_at\": \"1991-10-19T21:03:55.522Z\",\n \"reviewed_by_staff_id\": \"urn:uuid:872ec6c7-65a4-5008-8845-6197f9d8dde2\",\n \"submission_id\": \"4b42efcb-ddca-1cc7-274a-d45726240c75\",\n \"decision_reason\": \"amet irure ex ut reprehenderit\",\n \"created_at\": \"1968-12-21T03:07:49.872Z\",\n \"updated_at\": \"2023-02-21T04:55:52.075Z\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"do dolor esse\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42f32b53-476a-5b7a-9dbd-8e9cac08398a", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "received" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b65afeed-d587-5f81-b1be-3d234b6aa449", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "received" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb8da357-33d3-5bf2-b9be-b11e18efc73c", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "received" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e867138c-213d-5770-8bb7-0252f1b4b661", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "received" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88fbba45-528e-5cc3-b788-e058b1664e37", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "review_status", "value": "confirmed" }, { "key": "status", "value": "received" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a736e21-c4c9-5675-bfbf-ca8abfdf1d46", "name": "Submit a referral to the clinic for its staff to confirm.", "request": { "name": "Submit a referral to the clinic for its staff to confirm.", "description": { "content": "The referral is held for review and answers 202 Accepted with a `Location` header pointing at the submission; it is not on the clinic's referral list until staff confirm it (unless the clinic has chosen to accept such submissions automatically). Confirming adds it as `received` - it does not accept the referral or book anything; the clinic decides that next, and a sender cannot. The `Idempotency-Key` header is REQUIRED - a retry with the same key returns the original submission, never a second one. This is a clinical referral, not the clinic referral programme. JSON only: a FHIR ServiceRequest body is not accepted.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6eebde52-2933-53dc-b800-7fffd2780ff2", "name": "Accepted - waiting for clinic staff. If the clinic has chosen to accept this kind of item from your key or connection without review, the body already shows `review_status: confirmed` and `accepted_automatically: true`; read `review_status`, not the status code.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `.../submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"ff4ed4a9-fd4a-13dd-519e-a38c908a51c8\",\n \"patient_id\": \"1c7af6a1-f6c9-9ce7-2269-781f7ad3501e\",\n \"resource_type\": \"referral\",\n \"action\": \"retract\",\n \"review_status\": \"rejected\",\n \"target_id\": \"6e4c2976-34bf-f1fb-d82f-2c2e58d103de\",\n \"accepted_automatically\": true,\n \"source\": \"api\",\n \"submitted_at\": \"2025-08-26T09:02:43.307Z\",\n \"decided_at\": \"1970-11-11T21:32:11.525Z\",\n \"decision_reason\": \"amet\",\n \"result_record_id\": \"a93afcc9-b0ba-1fea-fcd6-a975a29193e6\",\n \"client_reference\": \"sed aliqua Excepteur\",\n \"origin_assistant_name\": \"sint velit cupidatat ut\",\n \"payload\": {}\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "954648bb-7bb5-52f3-8ab9-0d664e98b3d5", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f41a242-eed2-5f80-bd5d-308384dff141", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e12532a5-1c5e-5d81-9009-ffad4027003c", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27561478-96e7-51a1-9e01-22e167e2effd", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e21009c-486d-580b-b4fd-c943403a0a8d", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d50077c9-88a8-59e4-bd59-c277eb728be6", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"a27b9cd4-8660-3801-8d33-dde7b72f5ca6\",\n \"service\": {\n \"text\": \"magna Excepteur\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"la\"\n }\n },\n \"reason\": {\n \"text\": \"consequat ipsum in do\",\n \"code\": {\n \"system\": \"icd-10-cm\",\n \"code\": \"Du\"\n }\n },\n \"priority\": \"routine\",\n \"needed_by\": \"2018-07-24\",\n \"clinical_summary\": \"et irure in dolore velit\",\n \"requester\": {\n \"name\": \"cupidatat adipisicing\",\n \"organization\": \"dolore amet anim ullamco\",\n \"npi\": \"9212158258\"\n },\n \"client_reference\": \"mollit reprehende\",\n \"origin_assistant_name\": \"amet velit incididunt sed aliquip\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46207f5b-5c3c-5ee7-9873-da6aacdd511c", "name": "Get one referral from the clinic's list.", "request": { "name": "Get one referral from the clinic's list.", "description": { "content": "Only a confirmed referral is fetchable by id. With `Accept: application/fhir+json` the answer is a FHIR R4 ServiceRequest.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d5ef613d-3648-5478-b05e-4e00239cf058", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a5931430-7ce7-ce16-5f05-474756baf198\",\n \"patient_id\": \"ebe35685-ff14-36ed-5fa2-f281a78468da\",\n \"direction\": \"incoming\",\n \"status\": \"completed\",\n \"service\": {\n \"text\": \"velit irure in enim\",\n \"code\": {\n \"value\": \"\"\n }\n },\n \"reason\": {\n \"text\": \"dolore voluptate sed\",\n \"code\": {\n \"value\": \"\"\n }\n },\n \"review_status\": \"withdrawn\",\n \"priority\": \"null\",\n \"clinical_summary\": \"sunt consequat laboris deserunt mollit\",\n \"requester\": {\n \"name\": \"adipisicing minim\",\n \"organization\": \"sit id irure amet\",\n \"npi\": \"et non in\"\n },\n \"recipient\": {\n \"provider_id\": \"urn:uuid:9a54feff-e2b9-0957-d333-8a26e4807008\",\n \"department_id\": \"b2dae535-a9c8-caf8-1788-4391b2851f40\"\n },\n \"requested_at\": \"2012-01-31T01:19:23.863Z\",\n \"needed_by\": \"1950-10-12\",\n \"scheduled_appointment_id\": \"urn:uuid:44dfc13d-d503-1de2-8388-161d7242f9ad\",\n \"source\": \"null\",\n \"origin_assistant_name\": \"aute ani\",\n \"accepted_by\": \"clinic\",\n \"reviewed_at\": \"1997-12-17T02:56:18.969Z\",\n \"reviewed_by_staff_id\": \"a2dddbe6-b466-8af2-a763-d27293e1c414\",\n \"submission_id\": \"urn:uuid:f1cbb012-cd5f-83ac-2aeb-bc47dfcb65c0\",\n \"decision_reason\": \"ipsum et dolore\",\n \"created_at\": \"1977-06-05T03:55:24.215Z\",\n \"updated_at\": \"1991-04-10T08:49:01.841Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b585dd2-d233-5d37-bbc1-5d79953fccb6", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448c21e7-5603-50bb-87d6-4758fd32906b", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ba44658-38d4-5c03-97e7-82fa027eee09", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16c748c3-f349-5b81-be41-78b2b965c9e6", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a473a462-4c72-55c6-821e-29df9c4ae476", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c954f59-0009-5cd7-89f0-7dc699fd1bc8", "name": "Propose a change to a referral you sent, or retract it.", "request": { "name": "Propose a change to a referral you sent, or retract it.", "description": { "content": "The change is held for clinic staff to confirm and answers 202 Accepted with a `Location` header pointing at the new submission; the referral is unchanged until then. You can change a referral only while the clinic has not acted on it (`status: received`); after staff accept, decline, schedule, complete or cancel it, the request is refused with a 400 saying the clinic has already actioned it. `status: entered_in_error` proposes a retraction, also only while `received`. A sender cannot accept, decline, schedule, complete or cancel a referral. The service cannot be changed. The `Idempotency-Key` header is optional. JSON only: a FHIR ServiceRequest body is not accepted.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2905a373-27fa-5abe-839e-84fe76db54d3", "name": "Accepted - waiting for clinic staff.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "The submission, `.../submissions/{submission_id}`.", "key": "Location", "value": "culpa qui consectetur" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"urn:uuid:140ba025-8b3f-4fb7-83e7-0c2953e30156\",\n \"patient_id\": \"urn:uuid:6032b270-5e66-5027-05b3-a77210edf04b\",\n \"resource_type\": \"referral\",\n \"action\": \"create\",\n \"review_status\": \"rejected\",\n \"target_id\": \"3be34e56-8619-ba31-6b31-c30460cc3d48\",\n \"accepted_automatically\": false,\n \"source\": \"api\",\n \"submitted_at\": \"1976-05-30T06:23:30.572Z\",\n \"decided_at\": \"2017-12-31T14:18:24.968Z\",\n \"decision_reason\": \"dolore\",\n \"result_record_id\": \"4981580a-a08e-f113-13f8-e2ac4023a022\",\n \"client_reference\": \"Excepteur ut consequat\",\n \"origin_assistant_name\": \"magna velit nostrud Excepteur\",\n \"payload\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c622ddc-8659-5283-93d5-41746e1684a9", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0f3bad5-9f45-515f-bfaf-8fd3299f7b44", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7276a3f4-b82b-50e2-a73e-33d5ca676849", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b42270cc-fcf6-5d61-880f-ee3bae82baf9", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5003e9-60b5-529d-bd23-d3b74ab75cc8", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ff56c86-dab7-56ee-8ff0-ddef6118ae9c", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "referrals", ":referral_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "referral_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"entered_in_error\",\n \"priority\": \"asap\",\n \"needed_by\": \"1991-08-30\",\n \"reason\": {\n \"text\": \"eu dolore nostrud\",\n \"code\": {\n \"system\": \"local\",\n \"code\": \"aliqua dolore ea e\"\n }\n },\n \"clinical_summary\": \"sit culpa mollit eu proident\",\n \"requester\": {\n \"name\": \"cillum nostrud Duis mollit tempor\",\n \"organization\": \"culpa dolor eu consectetur\",\n \"npi\": \"1694429162\"\n },\n \"client_reference\": \"mollit dolor ut adipisi\",\n \"origin_assistant_name\": \"qui dolore \"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5e56a6d2-d9fe-5132-80f3-ad2343d80083", "name": "Providers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "151f8512-9b39-526e-ac9d-c9ea739efeb6", "name": "List the clinic's providers (its clinicians).", "request": { "name": "List the clinic's providers (its clinicians).", "description": { "content": "The clinic's directory of clinicians: the staff who can author clinical notes, excluding expired memberships. It is read only — there is no way to create, change or remove a provider through the API. Each provider carries the name, title, role, specialties, department, NPI and licences the clinic holds for them; email, phone and every other staff detail are never exposed, and there is no verified flag. `q` (at least 2 characters) matches the provider's name. The provider `id` is the same id the clinician pickers use. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 Practitioner resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "veniam Excepteur consequat ut nulla" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "91b8b97c-c2bd-5d84-b476-86342d878dd9", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "veniam Excepteur consequat ut nulla" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:12b96729-dc0c-1682-4bc0-913a996cb509\",\n \"display_name\": \"nulla eiusmod irure Duis\",\n \"role\": \"ipsum\",\n \"specialties\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"licenses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"title\": \"nulla\",\n \"department\": {\n \"value\": \"\"\n },\n \"npi\": \"ex cupidatat eu in\"\n },\n {\n \"id\": \"urn:uuid:54a4451a-f513-747f-61b3-a75f691c0699\",\n \"display_name\": \"est aliquip sit Duis\",\n \"role\": \"eiusmod est\",\n \"specialties\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"licenses\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"title\": \"dolore m\",\n \"department\": {\n \"value\": \"\"\n },\n \"npi\": \"id cillum incididunt anim\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"est laboris in esse\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9070934c-f232-59af-a032-c4c6aa8ef02d", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "veniam Excepteur consequat ut nulla" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a609053-5868-568d-a6db-339b5885641f", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "veniam Excepteur consequat ut nulla" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53f0ab9c-62c8-5887-aaef-aae7418cf1d5", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "veniam Excepteur consequat ut nulla" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c74f3ff8-cc99-5d74-baa6-6c3cb60f082b", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "veniam Excepteur consequat ut nulla" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9242ae4-a28a-5a7d-ae43-a91170f5cbee", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "veniam Excepteur consequat ut nulla" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa6dc51d-c875-5e84-8482-efbca31c19bb", "name": "Get one of the clinic's providers.", "request": { "name": "Get one of the clinic's providers.", "description": { "content": "A person who is not one of the clinic's providers, or whose membership has expired, answers the same 404 as one that does not exist. With `Accept: application/fhir+json` the answer is a FHIR R4 Practitioner.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "providers", ":provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "provider_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5a32ac8e-6827-5a09-bb76-a98edb96d343", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers", ":provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a0be2124-e9e7-fce4-c729-80427e9146db\",\n \"display_name\": \"ad amet incididunt\",\n \"role\": \"adipi\",\n \"specialties\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n },\n \"is_primary\": {\n \"value\": \"\"\n }\n }\n ],\n \"licenses\": [\n {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"expires_on\": {\n \"value\": \"\"\n }\n },\n {\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"expires_on\": {\n \"value\": \"\"\n }\n }\n ],\n \"title\": \"nisi in pariatur\",\n \"department\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"npi\": \"in incididunt Excepteur\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42f6aa5e-594f-506b-a544-c5610fad96d9", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers", ":provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd09b35-86b7-5954-b8c5-c518e32333fa", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers", ":provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "444c134f-1425-5cd1-8bba-83f86cf1321c", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers", ":provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8faa48f5-2989-5a09-a23f-b4e3f00f18d3", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers", ":provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7911d847-7d61-51d4-b039-1eb24ffd686a", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "providers", ":provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6385a669-0064-58a0-8541-2c5c23acaca4", "name": "CareProviders", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "51fe3d2f-93f8-5ec4-a2f6-debe03498d17", "name": "List one patient's outside care providers.", "request": { "name": "List one patient's outside care providers.", "description": { "content": "The clinicians outside the clinic that a patient names: their own doctor, a referring doctor, a specialist. `patient_id` is required. `type` filters to one kind. Every contact on the patient's record is listed, whoever added it; `source` says whether the clinic or an app did, and `editable` says whether this key's app may change or remove it. A restricted patient's contacts are never returned. Outside care providers are JSON only — there is no FHIR representation.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "type", "value": "specialist" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ed3211cc-dc81-5397-b09a-24e009bce972", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "type", "value": "specialist" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"ffde7abd-cbd0-bfe9-9412-6c9fd6b7b2a9\",\n \"patient_id\": \"b33fd152-312c-fd04-99b2-9f5babd3dd62\",\n \"type\": \"specialist\",\n \"name\": \"et ea\",\n \"is_primary\": false,\n \"source\": \"clinic\",\n \"editable\": false,\n \"practice_name\": \"laboris fugiat ut\",\n \"specialty\": \"ut aliquip\",\n \"npi\": \"minim pariatur nostrud\",\n \"phone\": \"minim Ut ipsum ad incididunt\",\n \"fax\": \"ex ut\",\n \"address\": \"veniam\",\n \"origin_assistant_name\": \"aliquip elit magna deserunt\",\n \"created_at\": \"1992-02-29T09:27:31.581Z\",\n \"updated_at\": \"1978-06-29T12:35:33.637Z\"\n },\n {\n \"id\": \"urn:uuid:e9f0cf48-6f9d-476d-4994-fa2ec374e131\",\n \"patient_id\": \"3f07c85f-8425-1cdf-5fb7-34efe7c8ad64\",\n \"type\": \"referring\",\n \"name\": \"fugiat quis \",\n \"is_primary\": true,\n \"source\": \"api\",\n \"editable\": true,\n \"practice_name\": \"ullamco sit\",\n \"specialty\": \"qui Exc\",\n \"npi\": \"pariatur do dolore et Excepteur\",\n \"phone\": \"proident enim exercitation ut\",\n \"fax\": \"dolore et do cillum\",\n \"address\": \"s\",\n \"origin_assistant_name\": \"velit qui\",\n \"created_at\": \"1980-10-31T12:43:47.782Z\",\n \"updated_at\": \"2017-06-01T12:54:55.773Z\"\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"laborum esse veniam\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df1868bb-b63e-5901-8571-e42d7f4a7b51", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "type", "value": "specialist" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c871fb31-34ef-5fc1-84a0-3252f80d3d93", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "type", "value": "specialist" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8824453-a5a5-5ee5-a216-8c5d40cece9c", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "type", "value": "specialist" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3c8ecac-d2b6-538d-b2c0-e73e42180536", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "type", "value": "specialist" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17b82fc9-2043-5ece-a7d9-3dc6fb8a15a4", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "type", "value": "specialist" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a470819c-6504-5fc5-8abf-651128a54b4d", "name": "Add an outside care provider to a patient.", "request": { "name": "Add an outside care provider to a patient.", "description": { "content": "Saved straight away and visible on the patient's record: answers 201 Created with the contact. If `is_primary` is true, the patient's other contacts of the same `type` stop being primary. The `Idempotency-Key` header is REQUIRED — a retry with the same key returns the original contact, never a second one. Contact notes cannot be sent. Only the contacts an app adds can later be changed or removed by that app.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5c88b805-5a0b-5551-b53d-bc150f891b4d", "name": "Created.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:6d328fb5-13e4-2c6a-7ea7-4f30596193d6\",\n \"patient_id\": \"urn:uuid:0aa55698-21b0-4720-35c9-f2fe874a71f9\",\n \"type\": \"referring\",\n \"name\": \"d\",\n \"is_primary\": true,\n \"source\": \"clinic\",\n \"editable\": false,\n \"practice_name\": \"qui enim\",\n \"specialty\": \"anim eiusmod molli\",\n \"npi\": \"velit amet esse irure Lorem\",\n \"phone\": \"labore voluptate pariatur\",\n \"fax\": \"minim sit incididunt Duis irure\",\n \"address\": \"pariatur ullamco\",\n \"origin_assistant_name\": \"in ad\",\n \"created_at\": \"1997-11-25T12:42:58.201Z\",\n \"updated_at\": \"2017-11-25T20:35:48.325Z\"\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0dcc99f-e1e9-5cce-8ea2-311a43589453", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7690a408-7d9d-576a-8084-a732b017ec40", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32b4dc97-1ef6-522c-88a3-0fb808dce56d", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ecfa07-b03b-5f9d-844e-6cb029fe17b2", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69569278-1d16-5dc1-8c57-dd98d4ca85ed", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "616dfb2c-9d54-509f-af73-cdea5549fb7b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"urn:uuid:3d96b0d0-8d64-60a4-4b47-d8048452f7dd\",\n \"name\": \"tempor consectetur\",\n \"type\": \"referring\",\n \"practice_name\": \"non\",\n \"specialty\": \"anim deserunt consequat cillum\",\n \"npi\": \"1611035296\",\n \"phone\": \"ut nostrud\",\n \"fax\": \"dolore voluptate adipisicing sint\",\n \"address\": \"commodo sunt\",\n \"is_primary\": false,\n \"origin_assistant_name\": \"Ut labore\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98e2385d-f5d0-5dce-a3b7-94a1c039be42", "name": "Get one outside care provider.", "request": { "name": "Get one outside care provider.", "description": { "content": "A restricted patient's contact answers the same 404 as one that does not exist.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e6086502-12c1-5471-8300-500ad21c224d", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:4785b5e0-7773-84ca-1339-ea0cf05a677a\",\n \"patient_id\": \"e03489f9-92a0-9de7-56cc-69a0489a634c\",\n \"type\": \"referring\",\n \"name\": \"ipsum in Excepteur cillum\",\n \"is_primary\": true,\n \"source\": \"api\",\n \"editable\": false,\n \"practice_name\": \"incididunt \",\n \"specialty\": \"Lorem consequat\",\n \"npi\": \"cillum voluptate\",\n \"phone\": \"ex aliqua ut\",\n \"fax\": \"sint culpa consequat ea\",\n \"address\": \"et Ut aute in adipisicing\",\n \"origin_assistant_name\": \"do dolore ipsum\",\n \"created_at\": \"1949-07-18T14:30:33.728Z\",\n \"updated_at\": \"1976-01-03T04:51:53.548Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f14797aa-4c6e-5b86-ae29-bf3f5340a98c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeed06a9-fa35-5c02-bae5-d41bd393ad37", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2356410-7297-52c4-a545-aa54d37ed798", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9b3d1f1-5e83-5fbb-b257-f70fe5d0a593", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac519f6-af7d-5dfe-8a8b-3b82df586282", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48557144-b1fa-5c17-8a28-a9a7fc289dc7", "name": "Change an outside care provider your app added.", "request": { "name": "Change an outside care provider your app added.", "description": { "content": "Answers 200 with the contact. Only a contact an app added can be changed, and only by an app of the same owner; a contact the clinic added (`editable: false`) answers 409 `care_provider_clinic_managed`. The patient cannot be changed. The `Idempotency-Key` header is optional.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8b489783-113e-593a-a95e-5f5107fcbe58", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"9cd71ffb-4dc1-0398-1c96-173f008e91d6\",\n \"patient_id\": \"93585388-6724-eb9e-454c-bf135fdd1bd4\",\n \"type\": \"pcp\",\n \"name\": \"dolore consectetur\",\n \"is_primary\": false,\n \"source\": \"clinic\",\n \"editable\": true,\n \"practice_name\": \"ut\",\n \"specialty\": \"in aliqua do\",\n \"npi\": \"aliqua et\",\n \"phone\": \"cupidatat labore dolore\",\n \"fax\": \"pariatur ea\",\n \"address\": \"Duis sint anim\",\n \"origin_assistant_name\": \"magna cillum d\",\n \"created_at\": \"1972-02-17T23:32:58.962Z\",\n \"updated_at\": \"1986-12-20T06:31:31.919Z\"\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "588c2935-dece-57dd-9a05-9097aff2715b", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "881bc144-cab3-5242-84e0-f655209fe407", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cc73127-1bae-51ee-8c92-8e15058f5b08", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1fe28ff-6505-567d-979c-424ee18d4022", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3f06edc-fc48-5903-92be-03ed2bfeebb2", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7c585f3-04b7-5823-95ff-529bb1386c81", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur\",\n \"type\": \"specialist\",\n \"practice_name\": \"et aute ex\",\n \"specialty\": \"ea sunt\",\n \"npi\": \"2575031293\",\n \"phone\": \"sed Ut dolore cil\",\n \"fax\": \"esse consectetur\",\n \"address\": \"in nulla sed ipsum\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09b1dbed-703e-54f2-8ee5-63b0806ec9a0", "name": "Remove an outside care provider your app added.", "request": { "name": "Remove an outside care provider your app added.", "description": { "content": "Answers 204 with no body. Only a contact an app added can be removed, and only by an app of the same owner; a contact the clinic added answers 409 `care_provider_clinic_managed`. A contact is a reference, not a clinical record, so it is deleted; the removal stays in the clinic's audit trail. There is no request body and no `Idempotency-Key`: removing a contact twice answers 404 the second time.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c9768fd4-d26c-54b2-a6e5-6835d7b2d02c", "name": "Removed. No body.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6958a8ce-84cd-5c57-964d-4a2b6aaad3cd", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aabc321-1859-5acc-ae52-1edc82d35cc6", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f607d9d6-aab9-50ca-ad37-c1eb55591161", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "674e54fa-a844-58b2-847a-391ab738bc4b", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "220b1a68-360e-53eb-93fd-9f09fb1c977c", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "611d665b-dc34-50cf-b595-92666d0db77b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "care-providers", ":care_provider_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "care_provider_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "28c709ab-acfb-566d-9d70-7777b24b61b5", "name": "Submissions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "05411a3e-4e95-5f57-abc5-60f748c98a77", "name": "Check what became of something this key submitted.", "request": { "name": "Check what became of something this key submitted.", "description": { "content": "Answers `pending`, `confirmed` (with `result_record_id`), `rejected` (with `decision_reason`) or `withdrawn`. Only the key or organization that submitted it can read it; anyone else gets the same 404 as for a submission that does not exist. Needs the write scope of the kind of record that was submitted (`conditions:write` for a condition, `allergies:write` for an allergy, `medications:write` for a reported medicine).", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "submissions", ":submission_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "submission_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a62cc84f-828a-5732-ad2a-1bfc6b734de3", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "submissions", ":submission_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "submission_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"submission_id\": \"urn:uuid:140ba025-8b3f-4fb7-83e7-0c2953e30156\",\n \"patient_id\": \"urn:uuid:6032b270-5e66-5027-05b3-a77210edf04b\",\n \"resource_type\": \"referral\",\n \"action\": \"create\",\n \"review_status\": \"rejected\",\n \"target_id\": \"3be34e56-8619-ba31-6b31-c30460cc3d48\",\n \"accepted_automatically\": false,\n \"source\": \"api\",\n \"submitted_at\": \"1976-05-30T06:23:30.572Z\",\n \"decided_at\": \"2017-12-31T14:18:24.968Z\",\n \"decision_reason\": \"dolore\",\n \"result_record_id\": \"4981580a-a08e-f113-13f8-e2ac4023a022\",\n \"client_reference\": \"Excepteur ut consequat\",\n \"origin_assistant_name\": \"magna velit nostrud Excepteur\",\n \"payload\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec27b705-6941-5314-84da-272ae4bc6cfa", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "submissions", ":submission_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "submission_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02923bca-1b9a-5eeb-ac97-f255f21d27ed", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "submissions", ":submission_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "submission_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51468eb6-e865-5021-a872-016589d95a11", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "submissions", ":submission_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "submission_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d9734b-dead-554f-80d7-6f93b6b54c54", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "submissions", ":submission_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "submission_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8905c17e-8fdf-570c-bc16-ec555b224a58", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "submissions", ":submission_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "submission_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a68b9203-3933-5b79-97fa-c58df78289f4", "name": "Payers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "989a0123-0b8b-5388-9343-f7cfded43528", "name": "List the insurance payers this clinic has enabled.", "request": { "name": "List the insurance payers this clinic has enabled.", "description": { "content": "Only the clinic's own active payers, the ones set up in Settings → Insurance, so a coverage can only point at a payer the clinic already works with. `q` matches the payer's name. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 Organization resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "irure incididunt do Lorem pariatur" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b4ffa955-54a7-5c35-9fcb-dc4f843312f4", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "irure incididunt do Lorem pariatur" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"df99a088-01d8-9d2a-28b1-c8e0b7d467d5\",\n \"display_name\": \"id\",\n \"primary_payer_id\": \"sint id esse nulla et\",\n \"coverage_types\": [\n \"do\",\n \"do\"\n ],\n \"operating_states\": [\n \"ullamco proident quis ut\",\n \"elit ut aliquip \"\n ]\n },\n {\n \"id\": \"9dd2b8c0-53a6-2885-d542-599561058279\",\n \"display_name\": \"occaecat aute dolore\",\n \"primary_payer_id\": \"enim sed ut id\",\n \"coverage_types\": [\n \"aliquip eu Lorem\",\n \"qui elit in amet sint\"\n ],\n \"operating_states\": [\n \"sed Duis\",\n \"consectetur velit e\"\n ]\n }\n ],\n \"has_more\": false,\n \"next_cursor\": \"ad dolore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "743519da-4b2d-5059-9e0c-b652f9e221ca", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "irure incididunt do Lorem pariatur" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515ed82e-260f-556f-911a-e756b3b8ce52", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "irure incididunt do Lorem pariatur" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "028b8ebd-33bc-502b-8ca9-2e0db01dd5be", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "irure incididunt do Lorem pariatur" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "625fa0da-5471-5ea3-9cd5-94e9e316b21a", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "irure incididunt do Lorem pariatur" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22b2f4c4-0ff1-5424-8d9e-4e827641d166", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "irure incididunt do Lorem pariatur" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37f7d00a-fc5e-5213-90d9-0e6f232bdba4", "name": "Get one of the clinic's enabled payers.", "request": { "name": "Get one of the clinic's enabled payers.", "description": { "content": "A payer the clinic has not enabled answers the same 404 as one that does not exist. With `Accept: application/fhir+json` the answer is a FHIR R4 Organization.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "payers", ":payer_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "payer_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "62975364-78f7-5db6-8cd6-5ff4e074a667", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers", ":payer_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "payer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:746a642b-7b1e-7d97-a405-30da840b07e3\",\n \"display_name\": \"esse Excepteur\",\n \"primary_payer_id\": \"sint aute\",\n \"coverage_types\": [\n \"sint\",\n \"Ut voluptate officia deserunt\"\n ],\n \"operating_states\": [\n \"irure Duis non ex\",\n \"consequat laboris\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5b9b14-490f-5326-ab3c-77e97847195c", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers", ":payer_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "payer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86779125-7d93-5d51-a9cd-27ce3ccc828d", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers", ":payer_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "payer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "910d9abf-9065-5837-8050-d5c692ef2fe0", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers", ":payer_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "payer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bceacfe-1e19-5e49-8596-b3c11c0ec763", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers", ":payer_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "payer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f438ce34-55e4-5c3c-91ab-461ff7f83f30", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "payers", ":payer_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "payer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ca52ad9b-2242-5e9c-95ad-60e8eea000e3", "name": "Coverages", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "72d04f1f-6cef-5712-b91f-3e89ff803e39", "name": "List one patient's insurance coverages.", "request": { "name": "List one patient's insurance coverages.", "description": { "content": "`patient_id` is required. `verification_status` filters to coverages staff have `confirmed`, ones still `unconfirmed` (added through the API and waiting for staff), or `all` (default). A restricted patient's coverages are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 Coverage resources; an unconfirmed coverage reads as status `draft`.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "verification_status", "value": "all" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0330ccf4-399e-5635-a599-7d93a92ae17e", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "verification_status", "value": "all" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:48ba1e7e-9e6a-1ef1-3ffd-31382ce785df\",\n \"patient_id\": \"urn:uuid:a4f466bf-3a26-d77c-f1cd-d97bd3a94f91\",\n \"coverage_active\": true,\n \"verification_status\": \"unconfirmed\",\n \"source\": \"api\",\n \"payer\": {\n \"value\": \"\"\n },\n \"member_id\": \"in sunt dolor\",\n \"group_number\": \"anim ut\",\n \"group_name\": \"ad cupidatat ullamco\",\n \"plan_name\": \"elit dolor sit ad\",\n \"coverage_type\": \"medical\",\n \"payment_responsibility\": \"S\",\n \"relationship_to_subscriber\": \"spouse\",\n \"subscriber\": {\n \"value\": \"\"\n },\n \"is_primary\": true,\n \"effective_date\": \"2011-11-27\",\n \"termination_date\": \"1999-09-16\",\n \"copay_amount\": 62358908.262103796,\n \"coinsurance_percent\": -10364693.403244019,\n \"deductible_amount\": -47699836.82781458,\n \"out_of_pocket_max\": 89528152.3000449,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"eligibility\": {\n \"value\": \"\"\n },\n \"origin_assistant_name\": \"Duis enim deserunt\",\n \"created_at\": \"2018-09-18T14:42:08.690Z\",\n \"updated_at\": \"1962-06-11T05:53:05.543Z\"\n },\n {\n \"id\": \"1d1f001f-099c-0031-8f01-e3205107248f\",\n \"patient_id\": \"67f78338-2d32-99cb-e4a3-01afa9eadef0\",\n \"coverage_active\": true,\n \"verification_status\": \"confirmed\",\n \"source\": \"clinic\",\n \"payer\": {\n \"value\": \"\"\n },\n \"member_id\": \"qui non culpa\",\n \"group_number\": \"veniam do\",\n \"group_name\": \"amet\",\n \"plan_name\": \"commodo culpa laboris\",\n \"coverage_type\": \"other\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"other\",\n \"subscriber\": {\n \"value\": \"\"\n },\n \"is_primary\": true,\n \"effective_date\": \"2015-06-07\",\n \"termination_date\": \"1950-03-30\",\n \"copay_amount\": -56675735.767930746,\n \"coinsurance_percent\": -80269416.56135023,\n \"deductible_amount\": 72824477.63718665,\n \"out_of_pocket_max\": -61100456.16514981,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"eligibility\": {\n \"value\": \"\"\n },\n \"origin_assistant_name\": \"fugiat do\",\n \"created_at\": \"2001-03-31T16:42:45.227Z\",\n \"updated_at\": \"1995-04-15T20:02:37.073Z\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"Excepteur et aute\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c93dd936-c4d0-5bc0-bc44-0550a910ebd0", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "verification_status", "value": "all" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3ee785b-97cd-57f9-92ab-aef01862171c", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "verification_status", "value": "all" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e81cb89-643d-5834-97d7-c7e1b2f31c0f", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "verification_status", "value": "all" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f423a60-9f82-5893-8132-ab18e53e83ad", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "verification_status", "value": "all" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13b04b87-95a9-5961-8337-92e4c9381d4b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "verification_status", "value": "all" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29511eb6-fd5b-5cf9-85cb-65a11686f767", "name": "Record a patient's insurance coverage.", "request": { "name": "Record a patient's insurance coverage.", "description": { "content": "The coverage is saved and visible straight away, answers 201 Created with the coverage, and is `unconfirmed` with `coverage_active: false` until clinic staff confirm the payer match. The payer must be one the clinic has enabled (`payer_not_enabled` otherwise). A patient can hold one coverage per payer (`coverage_exists`). The `Idempotency-Key` header is REQUIRED — a retry with the same key returns the original coverage, never a second one. Send JSON; a FHIR Coverage body is refused.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ed5291c2-fe43-5fff-ab94-c5fefd21cb8e", "name": "Created — saved, unconfirmed and inactive until staff confirm it.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"583b25a5-f977-5724-9494-e9429b6bfab3\",\n \"patient_id\": \"urn:uuid:77e37ee0-5d0b-0c5e-9c49-ddf97ca5c650\",\n \"coverage_active\": false,\n \"verification_status\": \"unconfirmed\",\n \"source\": \"api\",\n \"payer\": {\n \"id\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n }\n },\n \"member_id\": \"ullamco eiusmod nulla\",\n \"group_number\": \"in labo\",\n \"group_name\": \"enim incididunt\",\n \"plan_name\": \"veniam ullamco eiusmod elit tempor\",\n \"coverage_type\": \"behavioral_health\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber\": {\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"date_of_birth\": {\n \"value\": \"\"\n },\n \"gender\": {\n \"value\": \"\"\n },\n \"member_id\": {\n \"value\": \"\"\n }\n },\n \"is_primary\": false,\n \"effective_date\": \"1966-02-13\",\n \"termination_date\": \"2015-06-01\",\n \"copay_amount\": 5341050.215065479,\n \"coinsurance_percent\": 59917171.39258981,\n \"deductible_amount\": 61948124.784976244,\n \"out_of_pocket_max\": 16257916.297763586,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"eligibility\": {\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n }\n },\n \"origin_assistant_name\": \"cupidatat veniam nostrud\",\n \"created_at\": \"1951-08-06T19:48:20.167Z\",\n \"updated_at\": \"2007-05-05T18:34:29.145Z\"\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fc1e38d-46ae-5ac2-9a99-9812134540a9", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eac3c83-1c1c-5a81-bbd9-ab291c16f90c", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64ad72f5-ef6b-5c0f-8310-bf1345f761bb", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e67263bb-9f36-5e0b-ba7d-335586740855", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2002252b-aae4-5896-99ee-77c1812fdfc5", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a712373-b9f0-5a2c-985f-7a1a11355e31", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"d04c6bba-e1b0-484b-60a5-259b41a11634\",\n \"payer_id\": \"urn:uuid:1d54417a-3fae-507a-63d0-6fef6d1066d7\",\n \"member_id\": \"do laboris sin\",\n \"group_number\": \"in sunt mollit\",\n \"group_name\": \"in eu ullamco officia nostrud\",\n \"plan_name\": \"deserunt occaecat\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"T\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"ad incididunt\",\n \"subscriber_last_name\": \"Excepteur ullamco\",\n \"subscriber_date_of_birth\": \"2016-05-24\",\n \"subscriber_gender\": \"U\",\n \"subscriber_member_id\": \"consequat in eiusmod\",\n \"subscriber_address_line1\": \"Excepteur culpa dolor\",\n \"subscriber_address_city\": \"qui dolor\",\n \"subscriber_address_state\": \"laborum\",\n \"subscriber_address_zip\": \"culpa\",\n \"coverage_active\": true,\n \"effective_date\": \"1960-04-07\",\n \"termination_date\": \"2003-02-25\",\n \"copay_amount\": 62309066.62531197,\n \"coinsurance_percent\": 7.631499762646854,\n \"deductible_amount\": 91857156.18077666,\n \"out_of_pocket_max\": 49923823.51774722,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"is_primary\": true,\n \"origin_assistant_name\": \"occaecat officia in\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f13d50a4-e5ce-5bf2-8ca4-e6dbf9378963", "name": "Get one insurance coverage.", "request": { "name": "Get one insurance coverage.", "description": { "content": "With `Accept: application/fhir+json` the answer is a FHIR R4 Coverage; an unconfirmed coverage reads as status `draft`.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0804e750-d64c-5863-b45b-c4dc4bef25b2", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"6c46ed48-11f1-cc1a-6e43-249dc26f2785\",\n \"patient_id\": \"urn:uuid:0e01edee-786b-ceb1-2aa1-f67348941970\",\n \"coverage_active\": false,\n \"verification_status\": \"confirmed\",\n \"source\": \"clinic\",\n \"payer\": {\n \"id\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n }\n },\n \"member_id\": \"labore\",\n \"group_number\": \"deserunt non in eu aliquip\",\n \"group_name\": \"laborum eiusmod est ut\",\n \"plan_name\": \"et tempor sunt\",\n \"coverage_type\": \"null\",\n \"payment_responsibility\": \"S\",\n \"relationship_to_subscriber\": \"employee\",\n \"subscriber\": {\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"date_of_birth\": {\n \"value\": \"\"\n },\n \"gender\": {\n \"value\": \"\"\n },\n \"member_id\": {\n \"value\": \"\"\n }\n },\n \"is_primary\": false,\n \"effective_date\": \"2019-12-23\",\n \"termination_date\": \"1975-08-28\",\n \"copay_amount\": -20112781.273201108,\n \"coinsurance_percent\": 43780456.80932701,\n \"deductible_amount\": 31181963.998824358,\n \"out_of_pocket_max\": -63209054.47937548,\n \"pre_authorization_required\": false,\n \"network_status\": \"out_of_network\",\n \"eligibility\": {\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n }\n },\n \"origin_assistant_name\": \"mollit culpa sint\",\n \"created_at\": \"2003-12-30T14:47:12.747Z\",\n \"updated_at\": \"1981-12-12T16:11:08.903Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa61fcc7-abe9-5d58-9dd5-43446b2fa94f", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8764a59-b87f-55db-a389-3af5cb4a4801", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e061e5e-9159-58fa-b668-974b8850f75c", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1bcc092-aff9-51d8-8da8-4636fa794cca", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6d2406c-5ee6-5abc-8614-7917764e498b", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9fba297-c0b0-58fa-8778-48a25774f9dd", "name": "Change a coverage, or end it.", "request": { "name": "Change a coverage, or end it.", "description": { "content": "Answers 200 with the coverage. Changing who the coverage is for on a confirmed coverage sends it back to unconfirmed and inactive for staff to confirm again. `coverage_active: false` and `termination_date` end a coverage; `coverage_active: true` is refused (`activation_requires_staff`). The `Idempotency-Key` header is optional. Send JSON; a FHIR Coverage body is refused.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7c5add62-f9a2-5901-a024-254e5fe1549e", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:377033c9-10f1-4557-6690-e45910e1f604\",\n \"patient_id\": \"8630d8e9-be48-262c-b1b4-0dad288333ab\",\n \"coverage_active\": true,\n \"verification_status\": \"unconfirmed\",\n \"source\": \"clinic\",\n \"payer\": {\n \"id\": {\n \"value\": \"\"\n },\n \"display_name\": {\n \"value\": \"\"\n }\n },\n \"member_id\": \"culpa eu dolore \",\n \"group_number\": \"anim incididunt s\",\n \"group_name\": \"officia in labore\",\n \"plan_name\": \"nostrud id\",\n \"coverage_type\": \"dental\",\n \"payment_responsibility\": \"null\",\n \"relationship_to_subscriber\": \"life_partner\",\n \"subscriber\": {\n \"first_name\": {\n \"value\": \"\"\n },\n \"last_name\": {\n \"value\": \"\"\n },\n \"date_of_birth\": {\n \"value\": \"\"\n },\n \"gender\": {\n \"value\": \"\"\n },\n \"member_id\": {\n \"value\": \"\"\n }\n },\n \"is_primary\": true,\n \"effective_date\": \"1948-12-16\",\n \"termination_date\": \"1964-12-25\",\n \"copay_amount\": 11133209.47624743,\n \"coinsurance_percent\": 8219143.049791455,\n \"deductible_amount\": 56136776.27407014,\n \"out_of_pocket_max\": 53326829.336583614,\n \"pre_authorization_required\": true,\n \"network_status\": \"null\",\n \"eligibility\": {\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n }\n },\n \"origin_assistant_name\": \"officia culpa\",\n \"created_at\": \"1966-12-08T07:28:25.610Z\",\n \"updated_at\": \"1984-07-11T18:04:54.131Z\"\n },\n \"idempotent_replay\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0f31842-cd97-537a-a83b-e571cfe2a6e1", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23443ced-595c-50cf-a630-6d864ebc7eb9", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c0d7dd-f890-5173-9662-6e31b8553234", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23683289-9633-56c0-96bd-d0496bd1d687", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd535e8f-f15a-5ab2-b7f2-3ad4e0c900ca", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23b4e0e6-55d0-547e-a537-5763f877c0a1", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "coverages", ":coverage_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "coverage_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"payer_id\": \"urn:uuid:3818da87-fa08-06bb-2d0d-134d23d50360\",\n \"member_id\": \"incididunt sed veniam sit\",\n \"group_number\": \"enim aliquip in\",\n \"group_name\": \"laboris offic\",\n \"plan_name\": \"officia nostrud sed\",\n \"coverage_type\": \"vision\",\n \"payment_responsibility\": \"P\",\n \"relationship_to_subscriber\": \"self\",\n \"subscriber_first_name\": \"in consectetur nulla amet tempor\",\n \"subscriber_last_name\": \"aliqua tempor elit\",\n \"subscriber_date_of_birth\": \"1998-05-21\",\n \"subscriber_gender\": \"F\",\n \"subscriber_member_id\": \"occaecat sint mollit in proident\",\n \"subscriber_address_line1\": \"dolor Lorem amet ullamco\",\n \"subscriber_address_city\": \"exercitation\",\n \"subscriber_address_state\": \"id ipsum Duis\",\n \"subscriber_address_zip\": \"mollit\",\n \"coverage_active\": true,\n \"effective_date\": \"1966-03-03\",\n \"termination_date\": \"1954-09-11\",\n \"copay_amount\": 36876188.148744404,\n \"coinsurance_percent\": 61.53740475419909,\n \"deductible_amount\": 46841260.814107955,\n \"out_of_pocket_max\": 41171171.9352752,\n \"pre_authorization_required\": false,\n \"network_status\": \"in_network\",\n \"is_primary\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "69338ecc-ac38-5773-9fc3-b1be5c5f6fb7", "name": "Encounters", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f80b6202-4314-534e-a6c1-0ac4bd58927d", "name": "List one patient's visits.", "request": { "name": "List one patient's visits.", "description": { "content": "An encounter is a visit note: the visit's status, dates, reason for visit and clinician, with no clinical text (read the note through Notes; the ids are shared). `patient_id` is required. `status` filters to `draft` (not yet signed) or `completed`. Sensitive notes and a restricted patient's visits are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 Encounter resources.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "description": "(Required) " }, { "disabled": false, "key": "status", "value": "draft" }, { "disabled": false, "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "346f532a-2566-57bb-8bff-091f6f552a25", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "draft" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"urn:uuid:f3729e23-7d12-6156-5901-ce745a9ebc36\",\n \"patient_id\": \"urn:uuid:54b8d771-5007-8e29-492a-167b16c09f1c\",\n \"kind\": \"consultation\",\n \"status\": \"draft\",\n \"period\": {\n \"start\": \"2011-09-06T01:43:17.518Z\",\n \"end\": \"1977-12-05T06:30:27.536Z\"\n },\n \"source\": \"clinic\",\n \"review_status\": \"confirmed\",\n \"class\": \"inpatient\",\n \"reason\": \"consequat non aliqua eu\",\n \"clinician_id\": \"urn:uuid:f5c0298f-eaaf-dc0b-4765-f44b3456be78\",\n \"origin_assistant_name\": \"Duis incididunt tempor laboris\",\n \"created_at\": \"1997-10-05T05:43:45.677Z\",\n \"updated_at\": \"1978-11-21T15:51:58.854Z\"\n },\n {\n \"id\": \"urn:uuid:25a3276b-ef28-8516-ba9d-d7a917e0a461\",\n \"patient_id\": \"urn:uuid:bf0541f3-dc1f-f385-8a94-02bc8cfb5ccd\",\n \"kind\": \"consultation\",\n \"status\": \"draft\",\n \"period\": {\n \"start\": \"1963-03-28T18:32:19.926Z\",\n \"end\": \"1994-09-27T14:22:49.000Z\"\n },\n \"source\": \"clinic\",\n \"review_status\": \"pending\",\n \"class\": \"inpatient\",\n \"reason\": \"quis incididunt\",\n \"clinician_id\": \"9fccfc89-b94b-0b76-1975-e68766644447\",\n \"origin_assistant_name\": \"esse ipsum sunt cillum\",\n \"created_at\": \"1948-12-23T21:44:56.864Z\",\n \"updated_at\": \"1981-02-05T04:20:32.329Z\"\n }\n ],\n \"has_more\": true,\n \"next_cursor\": \"id Ut in dolore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f43fccea-7c1c-5c4e-a8d3-a9bd75b8f193", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "draft" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8815ce26-c935-5cb7-bb47-59f4a94ed5e7", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "draft" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff52bf54-ec75-52b4-bf99-b39c61bb18bc", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "draft" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "532775a7-557e-5f66-be7d-5d0e441c23db", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "draft" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2981d3f0-446a-5e47-96e9-ebb30b6836a6", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "patient_id", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" }, { "key": "status", "value": "draft" }, { "key": "updated_since", "value": "1975-06-20T23:08:03.899Z" }, { "key": "limit", "value": "25" }, { "key": "starting_after", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd" } ], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb8ad9bd-ce46-595b-a090-0ca53756e053", "name": "Open a visit as a draft note.", "request": { "name": "Open a visit as a draft note.", "description": { "content": "Opens a visit for a patient as a DRAFT note a clinician completes, and answers 201 Created with the encounter (`status: draft`, `review_status: pending`). Nothing is ordered, prescribed, signed, locked or billed, and no note text can be sent; the draft appears in the clinic's consultation list for a clinician to finish. A restricted patient is a 404. The `Idempotency-Key` header is REQUIRED — a retry with the same key returns the original encounter, never a second draft. Send JSON; a FHIR Encounter body is refused.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Unique per logical write. Retrying with the same key replays the first response; a new key makes a new write." } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "846b3cd7-2a47-51ed-8b43-0e96a5336bf2", "name": "Created — a draft visit note awaiting a clinician.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"urn:uuid:86539913-9812-315a-2169-e034707c14f4\",\n \"patient_id\": \"urn:uuid:03c9085c-0a29-2afd-8bd7-f3748719d9f5\",\n \"kind\": \"consultation\",\n \"status\": \"draft\",\n \"period\": {\n \"start\": \"2015-10-09T20:33:45.760Z\",\n \"end\": \"1970-09-09T06:02:00.173Z\"\n },\n \"source\": \"api\",\n \"review_status\": \"pending\",\n \"class\": \"null\",\n \"reason\": \"ea\",\n \"clinician_id\": \"27abc4fc-020e-2e83-8272-cf119b0383b0\",\n \"origin_assistant_name\": \"ea sed anim quis incididunt\",\n \"created_at\": \"2017-06-03T11:03:34.481Z\",\n \"updated_at\": \"1993-07-20T21:33:10.300Z\"\n },\n \"idempotent_replay\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31d9b972-5033-5420-8a9c-647d676dea4f", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b09daec3-7586-50d6-bea8-7bfee5e89a12", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0881e88-d7ce-5557-b723-7ade0c0b2988", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe79e59-5553-5dd6-bd1d-10f8b10d1790", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b050ea0-2a1c-5db2-b13a-478375606c9f", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://ZDkdnzsIwVNbnFbC.aaqbfx6.PgjxYisxxhAAkaZnrV.o.ubT6eiejMTex,idnHCg\",\n \"title\": \"tempor in\",\n \"status\": 30461469,\n \"code\": \"ei\",\n \"request_id\": \"occaecat aliqua esse enim sed\",\n \"detail\": \"veniam mollit et eu\",\n \"errors\": [\n {\n \"pointer\": \"sunt ipsum dolore cupidatat qui\",\n \"message\": \"fugiat id\"\n },\n {\n \"pointer\": \"id\",\n \"message\": \"non labore ut dolore\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b288ff-495f-5ba1-924c-3bdf2e6f2940", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"patient_id\": \"e5a0a820-410a-13d2-380a-b472a294edfb\",\n \"clinician_id\": \"18a2c21f-2807-cafa-d896-4716310da83b\",\n \"class\": \"home_health\",\n \"started_at\": \"1955-11-16T08:59:05.852Z\",\n \"ended_at\": \"2014-04-04T21:43:17.066Z\",\n \"reason\": \"Ut ipsum commodo sunt est\",\n \"origin_assistant_name\": \"et ut\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9d0239b-4426-56eb-9d9a-7396b1de4c83", "name": "Get one visit.", "request": { "name": "Get one visit.", "description": { "content": "The visit's details only — no clinical text. With `Accept: application/fhir+json` the answer is a FHIR R4 Encounter.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3515f067-3fa6-5faf-bab5-52a95a5476d5", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"c61eccb7-a39c-185c-986f-2ce640fc11a6\",\n \"patient_id\": \"urn:uuid:c2bd1884-5f63-17a1-edca-009110c3c9c6\",\n \"kind\": \"consultation\",\n \"status\": \"completed\",\n \"period\": {\n \"start\": \"1956-01-31T07:43:01.768Z\",\n \"end\": \"1958-02-26T06:11:12.646Z\"\n },\n \"source\": \"api\",\n \"review_status\": \"pending\",\n \"class\": \"ambulatory\",\n \"reason\": \"ullamco adipisicing\",\n \"clinician_id\": \"d2c51ef9-707d-3f19-4ea2-e9892a14e99d\",\n \"origin_assistant_name\": \"sint in incididunt\",\n \"created_at\": \"1974-05-14T08:13:03.359Z\",\n \"updated_at\": \"1958-08-03T15:00:36.109Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "995ad119-c560-58cd-a1f0-64f6beb8cb29", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "360abe33-f07d-59a8-aebf-dd992794523e", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd48b900-4245-5d0a-bab5-710be66379ec", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ec36f70-33c4-5360-8fe0-b9312e44326e", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d72b88d-9808-5ae9-81fa-7561a35a7dd3", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac55226b-ea23-5b76-be63-e71f66b107ba", "name": "Change the details of a visit the API opened.", "request": { "name": "Change the details of a visit the API opened.", "description": { "content": "Answers 200 with the encounter. Changes the visit's class, start, end or reason, and only on a draft the SAME key opened that no clinician has edited since: a signed, locked or clinician-edited visit is refused with 409 `note_not_editable`, and a visit opened by anyone else is a 404. It never changes note text and never signs, locks or finalizes. The `Idempotency-Key` header is optional. Send JSON; a FHIR Encounter body is refused.", "type": "text/plain" }, "url": { "path": [ "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "485593f8-d6f0-51c9-b248-59d0549ccbfb", "name": "OK.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"abdac835-8277-dbae-084c-ecd69c496600\",\n \"patient_id\": \"060755c9-7bf8-1620-aac4-d9d0e25d5813\",\n \"kind\": \"consultation\",\n \"status\": \"completed\",\n \"period\": {\n \"start\": \"1957-07-10T13:37:41.650Z\",\n \"end\": \"1954-05-21T21:50:24.529Z\"\n },\n \"source\": \"clinic\",\n \"review_status\": \"pending\",\n \"class\": \"emergency\",\n \"reason\": \"cillum consectetur\",\n \"clinician_id\": \"urn:uuid:7d9a1672-8d03-084d-c3cc-3ca807d272c7\",\n \"origin_assistant_name\": \"exercitation\",\n \"created_at\": \"1995-09-27T19:22:49.170Z\",\n \"updated_at\": \"2022-12-12T08:45:12.841Z\"\n },\n \"idempotent_replay\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "513c11ee-ede3-500f-be56-4bd237ea4f1e", "name": "The request failed validation (unknown query parameter, limit out of range, malformed body).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37c0f376-af64-5fc5-9f15-b179bb8d83cc", "name": "Missing, malformed, unknown, revoked or expired key, or the wrong secret.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "339e1b67-3e40-5138-b208-1f1bb1d6eff0", "name": "The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "781ab5ce-47ac-5f76-9690-4f845789bc9f", "name": "The record is absent, or out of the key's scope — one message for both.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a52bee2-3d3f-5391-a510-9273ca88d1c3", "name": "The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30c8d2a9-2c60-5898-83bd-1a9f3b02a793", "name": "Rate limited. See the Retry-After header.", "originalRequest": { "url": { "path": [ "v1", "clinics", ":clinic_id", "encounters", ":encounter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "clinic_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "e1407688-5134-3afc-ee84-fadb72b05dfd", "key": "encounter_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"class\": \"virtual\",\n \"started_at\": \"1956-08-25T08:47:03.267Z\",\n \"ended_at\": \"1970-06-23T07:11:34.830Z\",\n \"reason\": \"exercitation Duis dolore magna\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://SCzz.ujnB+2uKvljSyC5NcGvugE8sZrWjD7pTcqyX\",\n \"title\": \"ipsum mollit\",\n \"status\": 50411645,\n \"code\": \"dolor enim tempor cillum\",\n \"request_id\": \"nostrud irure m\",\n \"detail\": \"consequat pariatur\",\n \"errors\": [\n {\n \"pointer\": \"nisi la\",\n \"message\": \"aliqua ad qui incididunt labore\"\n },\n {\n \"pointer\": \"esse fugiat\",\n \"message\": \"aliquip nulla consectetur\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.clinikehr.com/v1", "type": "string" }, { "key": "bearerToken", "value": "ehr_test_REPLACE_ME", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "info": { "_postman_id": "e2e30b0c-5fe1-5a03-9b18-bd605f571a1c", "name": "ClinikEHR API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Server-to-server REST API over a clinic's own non-PHI inventory data, reached with a clinic-owned key. No PHI scope exists yet — every operation below carries x-phi: false. A workspace's TEST key resolves ONLY to that workspace's own synthetic sandbox clinic, never a real one; `sandbox: true` on `Me` and on a `GET /v1/connections` entry marks that the data behind it is the seeded sandbox, not a real clinic's catalogue. The five inventory operations below are unchanged in their request/response shape for a sandbox call — the database, not this document or the router, decides which store answers. Every list operation (`GET …/inventory/locations`, `GET …/items`, `GET …/stock`, `GET /v1/connections`) wraps its rows as `{ data, has_more, next_cursor }`. `POST …/inventory/availability` wraps its rows as `{ data }` only (no pagination — it answers exactly the entries it was asked about). This is the gateway's actual, deployed behaviour; `_shared/ehr-api/openapi/response-envelope-parity.test.ts` pins it.", "type": "text/plain" } } }