{"info":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","description":"

These are the methods available via the PatientPal API.

Authentication uses a JSON Web Token (JWT). Generate an API Key for your clinic by logging in and going to your Account Settings and selecting API Keys.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

API	Endpoint
Production	https://api.patientpal.io
Staging	https://staging.patientpal.io

Notice: The PatientPal API treats HTTP status 401 to mean Unauthenticated and not the HTTP standard name of Unauthorized. Requests made for materials the requester does not have permission to access, the API will respond with 403: Forbidden.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3770786","collectionId":"e5b84716-a293-7cf5-4970-75f4a1799f76","publishedId":"RVfzeof9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2025-03-11T18:15:57.000Z"},"item":[{"name":"Appointments","item":[{"name":"Get Appointments","event":[{"listen":"test","script":{"id":"5914b5e0-56be-4417-9547-34533388949d","exec":["var response = JSON.parse(responseBody);","","tests[\"is success\"] = response.success === true;","","pm.environment.set(\"PATIENT_ID\", response.data[0].id);",""],"type":"text/javascript"}}],"id":"1c68dc44-7e67-4f0b-96fa-e76f8589addd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/appointments?start=2019-05-15T04:00:00.000Z&end=2019-05-16T03:59:59.999Z&extend=patient,products&categoryId=9488fe5f-62c9-4051-9706-571aad754d79","description":"

Get upcoming appointments.

Optional. Exclude appointments scheduled prior to specified date.

\n","type":"text/plain"},"key":"start","value":"2019-05-15T04:00:00.000Z"},{"description":{"content":"

Optional. Exclude appointments scheduled after the specified date.

\n","type":"text/plain"},"key":"end","value":"2019-05-16T03:59:59.999Z"},{"disabled":true,"description":{"content":"

Optional. Include only appointments with specified status.

\n","type":"text/plain"},"key":"status","value":"O"},{"description":{"content":"

Optional. Rather than returning record IDs, return the records themselves.

\n","type":"text/plain"},"key":"extend","value":"patient,products"},{"description":{"content":"

Optional. Include only appointments for a specific product / procedure category.

\n","type":"text/plain"},"key":"categoryId","value":"9488fe5f-62c9-4051-9706-571aad754d79"},{"disabled":true,"description":{"content":"

Optional. Include only appointments for a specific clinic location.

\n","type":"text/plain"},"key":"locationId","value":"857bbeab-5b1d-48a7-945c-687d166c6745"}],"variable":[]}},"response":[{"id":"3f0902ed-fb47-41a3-a2bd-fbbdd511cf56","name":"/appointments","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"url":"https://api.patientpal.io/appointments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Date","value":"Thu, 19 Jul 2018 20:34:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"access-control-allow-headers","value":"Content-Type,Authorization,WWW-Clinic-ID","name":"access-control-allow-headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"access-control-allow-origin","value":"*","name":"access-control-allow-origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"cache-control","value":"no-cache","name":"cache-control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"content-encoding","value":"gzip","name":"content-encoding","description":"The type of encoding used on the data."},{"key":"content-type","value":"application/json; charset=utf-8","name":"content-type","description":"The mime type of this content"},{"key":"vary","value":"origin,accept-encoding","name":"vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[],"responseTime":null,"body":"{\"success\":true,\"data\":[{\"id\":\"f1cf6df0-f45a-43fd-967c-19b70b3a08ed\",\"clinicId\":\"0c9bc41a-54be-41cc-8658-0c31014e692a\",\"patientId\":\"c3447a1d-6a7d-4515-ae6f-52897a2beb87\",\"dtstart\":\"2018-07-17T20:30:07.000Z\",\"dtend\":\"2018-07-17T21:30:07.000Z\",\"status\":\"O\",\"priority\":3,\"products\":[73721],\"createdAt\":\"2018-07-19T20:12:52.867Z\",\"updatedAt\":\"2018-07-19T20:12:52.867Z\"},{\"id\":\"93099cc3-a06d-42f6-898b-aa6246c9983e\",\"clinicId\":\"0c9bc41a-54be-41cc-8658-0c31014e692a\",\"patientId\":\"c3447a1d-6a7d-4515-ae6f-52897a2beb87\",\"eid\":\"appointment1\",\"dtstart\":\"2018-07-17T20:30:07.000Z\",\"dtend\":\"2018-07-17T21:30:07.000Z\",\"status\":\"O\",\"priority\":3,\"products\":[73721],\"createdAt\":\"2018-07-19T20:32:37.724Z\",\"updatedAt\":\"2018-07-19T20:32:37.724Z\"}]}"}],"_postman_id":"1c68dc44-7e67-4f0b-96fa-e76f8589addd"},{"name":"Get Appointment Details","id":"29faa51d-fa71-4a61-900d-45b6546646da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.patientpal.io/appointments/:id","description":"

Fetch the an overview of the appointment by the PatientPal Appointment ID or the Accession Number from the EMR.

PatientPal Appointment ID or EMR Accession Number.

\n","type":"text/plain"},"type":"any","value":"TEST1","key":"id"}]}},"response":[{"id":"ea24e59b-aecf-4e96-9084-21b8314a46d4","name":"Get Appointment Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.patientpal.io/appointments/:id","host":["https://api.patientpal.io"],"path":["appointments",":id"],"variable":[{"key":"id","value":"TEST1","description":"PatientPal Appointment ID or EMR Accession Number"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"10410cb4-d53a-40b5-8d24-c3d25c418801\",\n \"patientId\": \"10410cb4-d53a-50b5-8d24-c3d25c418882\",\n \"eid\": \"TEST1\",\n \"startAt\": \"2021-06-04T14:45:00.000Z\",\n \"endAt\": \"2021-06-04T15:15:00.000Z\",\n \"status\": \"C\",\n \"priority\": 3,\n \"notes\": \"MRI LEFT KNEE WITHOUT CONTRAST\",\n \"products\": [],\n \"insurances\": [\n {\n \"carrierLookupId\": \"ce07f979-dae4-4d2e-9f85-e73bd35e9f15\",\n \"clinicCarrierId\": \"321412\",\n \"clinicCarrierName\": \"Change Test\",\n \"memberId\": \"0000000000\",\n \"type\": \"PRIMARY\"\n },\n {\n \"carrierLookupId\": \"1d4d14be-002b-483a-9d82-4a24d64690c1\",\n \"clinicCarrierId\": \"22222\",\n \"clinicCarrierName\": \"Availity Mock\",\n \"memberId\": \"999666333111\",\n \"type\": \"PRIMARY\"\n }\n ],\n \"eligibilityStatus\": \"N\",\n \"intakeStatus\": \"D\",\n \"paymentStatus\": \"A\",\n \"resources\": [],\n \"locationId\": \"857bbeab-5b1d-48a7-945c-687d166c6745\",\n \"createdAt\": \"2021-06-03T16:05:03.580Z\",\n \"updatedAt\": \"2021-06-03T16:05:03.580Z\",\n \"intakeCompleted\": false,\n \"invoices\": [],\n \"facility\": {\n \"id\": \"857bbeab-5b1d-48a7-945c-687d166c6745\",\n \"name\": \"Uptown\",\n \"abbreviation\": \"Uptown\",\n \"timezone\": \"America/New_York\"\n },\n \"timezone\": \"America/New_York\",\n \"metadata\": {\n \"TestKey1\": \"TestValue\",\n \"TestKey2\": \"TestValue\",\n \"TestKey3\": \"TestValue\",\n \"TestKey4\": \"TestValue\",\n \"TestKey5\": \"TestValue\"\n }\n }\n}"}],"_postman_id":"29faa51d-fa71-4a61-900d-45b6546646da"},{"name":"Update Appointment","event":[{"listen":"test","script":{"id":"84b5fdfe-d116-4593-a258-d8d9a838cff0","exec":["var response = JSON.parse(responseBody);","","tests[\"is success\"] = response.success === true;","","pm.environment.set(\"PATIENT_ID\", response.data.id);"],"type":"text/javascript"}}],"id":"53b99dc0-19b2-457c-8bfc-076b03d959a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eid\": \"appointment1\",\n \"patient\": {\n \"eid\": \"customeid1\",\n \"name\": {\n \t\"given\": \"Bob\",\n \t\"family\": \"Roberts\"\n },\n \"email\": \"bob@roberts.name\",\n \"phone\": \"+1-234-567-9012\",\n \"dob\": \"1992-11-30\"\n },\n \"startAt\": \"2018-07-17T20:30:07+00:00\",\n \"endAt\": \"2018-07-17T21:30:07+00:00\",\n \"priority\": false,\n \"referringPhysician\": \"Dr. John Jacobs\",\n \"notes\": \"Some random notes\",\n \"products\": [\n 73721\n ]\n}"},"url":"https://api.patientpal.io/appointments/:id","description":"

Upsert an appointment (to automatically create or update an appointment automagically)

Fields

startAt (required if creating a new appointment) provides the appointment's start date and time. Must use ISO-8601 format. Include timezone offset or times will default to UTC.
\n
endAt (required if creating a new appointment) provides the appointment's end date and time. Must use ISO-8601 format. Include timezone offset or times will default to UTC.
\n
priority whether this appointment is a priority and must happen ASAP. Can be specified as a boolean (true, numeric value of 6), defaults to false (numeric value of 3). Alternatively can specify a numeric value between 0-9.
\n
status is a single character string to represent the state of an appointment. Options are: O (Open, default), C (Cancelled), I (In Progress), D (Done).
\n
id can be the appointment's unique record ID of the appointment being updated, if available.
\n
eid can be the ID for the appointment in the clinic's external scheduling software, when id is not provided this eid can be used to upsert an appointment.
\n
patient can be the patient's unique record ID or must be an object and contain the information to upsert a patient, similar to the data provided for the POST /clinician/patient route.
\n
products is an array of the products and/or services expected to be rendered and provided at the time of the appointment. The array must be an array of strings, the values are either the unique product record ID for the clinic or a CPT code.
\n
notes is a string field that can store any associates notes or description for the appointment.
\n

Caveats

When id and eid are undefined, this route will always create a new appointment.
When id and eid are undefined for the patient field, a new patient will always be created.

PatientPal Appointment ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"53b99dc0-19b2-457c-8bfc-076b03d959a9"}],"id":"38d27204-33fd-46ff-98cc-14ec93c37852","_postman_id":"38d27204-33fd-46ff-98cc-14ec93c37852","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]},"isInherited":true,"source":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","type":"collection"}}},{"name":"Clinics","item":[{"name":"Get Clinic Details","event":[{"listen":"test","script":{"id":"9992dd35-70d2-4e61-a025-7e2f87d138f1","exec":["var response = JSON.parse(responseBody);","","tests[\"is success\"] = response.success === true;","","pm.environment.set(\"CLINIC_ID\", response.data.id);"],"type":"text/javascript"}}],"id":"37da884d-830a-992c-7d7e-f70e5c88d446","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.patientpal.io/clinics/:id","description":"

Get details about a clinic.

\n","urlObject":{"path":["clinics",":id"],"host":["https://api.patientpal.io"],"query":[],"variable":[{"description":{"content":"

An identifier for the clinic. The clinic's UUID, subdomain on patientpal.com, or their custom domain.

\n","type":"text/plain"},"type":"string","value":"demo.patientpal.com","key":"id"}]}},"response":[{"id":"82bc3807-cf0a-4da7-a7bf-907f5b528949","name":"/clinic/:id (success)","originalRequest":{"method":"GET","header":[],"url":"https://api.patientpal.io/clinic/localhost"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"0c9bc41a-54be-41cc-8658-0c31014e692a\",\n \"name\": \"Tiny Twig\",\n \"slug\": \"localhost\",\n \"email\": \"example@customer.com\",\n \"phoneNumber\": \"+14324242342\",\n \"twilioNumber\": \"+17242020589\",\n \"languages\": [\n \"en\",\n \"es\"\n ],\n \"website\": \"https://www.longwoodmri.com/\",\n \"isDisabled\": false,\n \"type\": \"diagnostic imaging\",\n \"provider\": {\n \"name\": \"PROVIDER NAME\",\n \"taxId\": \"0001\",\n \"id\": \"0001\"\n },\n \"options\": {\n \"inAutoAccidentRelated\": true,\n \"inWorkersCompRelated\": true,\n \"inEmergencyContact\": true,\n \"inPrimaryInsurance\": true,\n \"inSecondaryInsurance\": true\n },\n \"modules\": {\n \"appointment\": true,\n \"appointmentRequests\": true,\n \"appointmentWaitList\": true,\n \"confirmation\": true,\n \"intake\": true,\n \"eligibility\": true,\n \"authorization\": true,\n \"estimate\": true,\n \"payment\": true,\n \"notes\": true,\n \"results\": true\n },\n \"modulesPreferences\": {\n \"intakeAllowFacebook\": false,\n \"unknownInsurance\": true,\n \"paymentPlans\": false,\n \"patientPayoff\": false\n },\n \"settings\": {\n \"supportPlan\": \"business\",\n \"billingMode\": \"usage\",\n \"billingAmount\": 1,\n \"billSupportMin\": 250,\n \"billSupportPercentage\": 0.1\n },\n \"createdAt\": \"2021-06-03T16:05:09.456Z\",\n \"updatedAt\": \"2021-06-03T16:05:09.458Z\",\n \"hasPaymentProvider\": true,\n \"image\": \"https://patientpal-public-dev.s3.amazonaws.com/0c9bc41a-54be-41cc-8658-0c31014e692a/logo.png\"\n }\n}"},{"id":"c9cd698c-e77f-6aeb-f9b6-18a21490bc58","name":"/clinic/:id (not found)","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.patientpal.io/clinic/{{CLINIC_ID}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""}],"cookie":[],"responseTime":"826","body":"{\"success\":false,\"message\":\"Not Found\"}"}],"_postman_id":"37da884d-830a-992c-7d7e-f70e5c88d446"},{"name":"Get Intake Questions","event":[{"listen":"test","script":{"id":"9992dd35-70d2-4e61-a025-7e2f87d138f1","exec":[""],"type":"text/javascript"}}],"id":"6a74e402-7cdf-4a4c-b716-5bf4bc95c6c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.patientpal.io/clinics/:id/questions","description":"

Get all the intake questions for a specific clinic.

\n","urlObject":{"path":["clinics",":id","questions"],"host":["https://api.patientpal.io"],"query":[],"variable":[{"description":{"content":"

The Clinic's UUID.

\n","type":"text/plain"},"type":"string","value":"{{CLINIC_ID}}","key":"id"}]}},"response":[],"_postman_id":"6a74e402-7cdf-4a4c-b716-5bf4bc95c6c4"},{"name":"Get Intake Sections","event":[{"listen":"test","script":{"id":"9992dd35-70d2-4e61-a025-7e2f87d138f1","exec":[""],"type":"text/javascript"}}],"id":"971dced2-6378-439c-bc4d-635da02a6321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.patientpal.io/clinics/:id/sections","description":"

Get all the intake sections for a specific clinic.

\n","urlObject":{"path":["clinics",":id","sections"],"host":["https://api.patientpal.io"],"query":[],"variable":[{"description":{"content":"

The Clinic's UUID.

\n","type":"text/plain"},"type":"string","value":"{{CLINIC_ID}}","key":"id"}]}},"response":[],"_postman_id":"971dced2-6378-439c-bc4d-635da02a6321"},{"name":"Get Intake Consents","event":[{"listen":"test","script":{"id":"9992dd35-70d2-4e61-a025-7e2f87d138f1","exec":[""],"type":"text/javascript"}}],"id":"51996531-28f9-4ecd-8677-e096668f8fa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.patientpal.io/clinics/:id/consents","description":"

Get all the intake consents for a specific clinic.

\n","urlObject":{"path":["clinics",":id","consents"],"host":["https://api.patientpal.io"],"query":[],"variable":[{"description":{"content":"

The Clinic's UUID.

\n","type":"text/plain"},"type":"string","value":"{{CLINIC_ID}}","key":"id"}]}},"response":[],"_postman_id":"51996531-28f9-4ecd-8677-e096668f8fa4"},{"name":"Get Products","event":[{"listen":"test","script":{"id":"9992dd35-70d2-4e61-a025-7e2f87d138f1","exec":[""],"type":"text/javascript"}}],"id":"9fab699e-80bb-4c79-9c92-a374449a9e69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.patientpal.io/clinics/:id/products","description":"

Get the products and procedures for a specific clinic.

\n","urlObject":{"path":["clinics",":id","products"],"host":["https://api.patientpal.io"],"query":[],"variable":[{"description":{"content":"

The Clinic's UUID.

\n","type":"text/plain"},"type":"string","value":"{{CLINIC_ID}}","key":"id"}]}},"response":[],"_postman_id":"9fab699e-80bb-4c79-9c92-a374449a9e69"}],"id":"06b44c64-8d62-477a-b714-5911cb4536a0","event":[{"listen":"prerequest","script":{"id":"a927976e-dc88-4089-b709-155d44b6c3e7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9b1dd05d-b788-4e36-925c-cdb1826f6d58","type":"text/javascript","exec":[""]}}],"_postman_id":"06b44c64-8d62-477a-b714-5911cb4536a0","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]},"isInherited":true,"source":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","type":"collection"}}},{"name":"Patients","item":[{"name":"Get Patients","event":[{"listen":"test","script":{"id":"5914b5e0-56be-4417-9547-34533388949d","exec":["var response = JSON.parse(responseBody);","","tests[\"is success\"] = response.success === true;","","pm.environment.set(\"PATIENT_ID\", response.data[0].id);",""],"type":"text/javascript"}}],"id":"1f7ff226-08a7-4e35-953b-8290b5a04e46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/patients?limit=100&eid=customeid1&phone=+12345678901&dob&email=bob@roberts.ext","description":"

Get list of all patients

Optional. Limit the number of possible responses.

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

Optional. Find a patient with a specific EID.

\n","type":"text/plain"},"key":"eid","value":"customeid1"},{"description":{"content":"

Optional. Find a patient with a specific phone number.

\n","type":"text/plain"},"key":"phone","value":"+12345678901"},{"description":{"content":"

Optional. Find patients with a specific date of birth.

\n","type":"text/plain"},"key":"dob","value":null},{"description":{"content":"

Optional. Find a patients with a specific email.

\n","type":"text/plain"},"key":"email","value":"bob@roberts.ext"}],"variable":[]}},"response":[{"id":"eed3ffdf-510e-4f18-a6c9-e49fd49a5ad5","name":"Get Patients","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.patientpal.io/patients?limit=100&eid=customeid1&phone=+12345678901&dob&email=bob@roberts.ext","host":["https://api.patientpal.io"],"path":["patients"],"query":[{"key":"limit","value":"100","description":"Optional. Limit the number of possible responses."},{"key":"eid","value":"customeid1","description":"Optional. Find a patient with a specific EID."},{"key":"phone","value":"+12345678901","description":"Optional. Find a patient with a specific phone number."},{"key":"dob","value":null,"description":"Optional. Find patients with a specific date of birth."},{"key":"email","value":"bob@roberts.ext","description":"Optional. Find a patients with a specific email."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-expose-headers","value":"Authorization,WWW-Authenticate,Server-Authorization"},{"key":"access-control-allow-headers","value":"Content-Type,Authorization,WWW-Clinic-ID"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"vary","value":"origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"cache-control","value":"no-cache"},{"key":"content-length","value":"633"},{"key":"accept-ranges","value":"bytes"},{"key":"Date","value":"Thu, 03 Jun 2021 20:37:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"857bbeab-5b1d-48a7-945c-687b196c0161\",\n \"clinicId\": \"0c9bc41a-54be-41cc-8658-0c31014e692a\",\n \"eid\": \"A12345\",\n \"ekey\": \"1000.01.1.1000001\",\n \"paymentProvider\": {\n \"customerId\": \"cus_IFO5GGXjDZa1DS\"\n },\n \"name\": {\n \"given\": \"BOB\",\n \"middle\": \"ROBBY\",\n \"family\": \"ROBERTS\",\n \"suffix\": \"II\",\n \"prefix\": \"MR\"\n },\n \"fullName\": \"ROBERTS, BOB ROBBY\",\n \"language\": \"en\",\n \"phone\": \"+12345678901\",\n \"address\": {\n \"zip\": \"10001\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"city\": \"New Town\",\n \"address1\": \"1 Main st\"\n },\n \"dob\": \"1965-10-05\",\n \"sex\": \"M\",\n \"email\": \"robbyroberts@bobby.name\",\n \"vip\": false,\n \"createdAt\": \"2021-06-03T16:05:23.046Z\",\n \"updatedAt\": \"2021-06-03T18:36:40.772Z\"\n }\n ],\n \"total\": 1\n}"}],"_postman_id":"1f7ff226-08a7-4e35-953b-8290b5a04e46"},{"name":"Get Patient Details","event":[{"listen":"test","script":{"id":"84b5fdfe-d116-4593-a258-d8d9a838cff0","exec":["var response = JSON.parse(responseBody);","","tests[\"is success\"] = response.success === true;","","pm.environment.set(\"PATIENT_ID\", response.data.id);"],"type":"text/javascript"}}],"id":"6c6da45b-97ad-4461-bca8-d86a331bd5dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/patients/:id","description":"

Get details about a patient by their patient id.

The Patient UUID.

\n","type":"text/plain"},"type":"string","value":"{{PATIENT_ID}}","key":"id"}]}},"response":[],"_postman_id":"6c6da45b-97ad-4461-bca8-d86a331bd5dd"},{"name":"Update Patient Details","event":[{"listen":"test","script":{"id":"84b5fdfe-d116-4593-a258-d8d9a838cff0","exec":[""],"type":"text/javascript"}}],"id":"170a0a4a-23cc-4de0-b00a-9538274df74b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"eid\": \"01\",\n\t\"ekey\": \"\",\n\t\"name\": {\n\t\t\"given\": \"Clark\",\n\t\t\"family\": \"Kent\"\n\t},\n\t\"dob\": \"1900-01-01\",\n\t\"phone\": \"333-555-7777\",\n\t\"email\": \"clark@kent.name\",\n\t\"sex\": \"M\"\n}"},"url":"https://api.patientpal.io/patients/:id","description":"

Update a Patient record.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`eid`	External ID. Usually the human-editable PID from the EMR.
`ekey`	External Key. Usually the machine-generated PID from the EMR.
`name`	Patient name, see `NameSchema`.
`phones`	Patient contact numbers, see `PhonesSchema`.
`email`	Patient's email.
`sex`	Patient's sex, possible values: `M`, `F`, `A`, `O`. See http://hl7.org/fhir/v2/0001/index.html
`dob`	Patient's date of birth, formatted as `YYYY-MM-DD`.

","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]},"isInherited":true,"source":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","type":"collection"}},"urlObject":{"path":["patients",":id"],"host":["https://api.patientpal.io"],"query":[],"variable":[{"description":{"content":"

The Patient UUID.

\n","type":"text/plain"},"type":"string","value":"{{PATIENT_ID}}","key":"id"}]}},"response":[],"_postman_id":"170a0a4a-23cc-4de0-b00a-9538274df74b"},{"name":"Delete Patient","event":[{"listen":"test","script":{"id":"84b5fdfe-d116-4593-a258-d8d9a838cff0","exec":[""],"type":"text/javascript"}}],"id":"0c521138-507e-42d3-a989-3ee671910a13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/patients/:id","description":"

Perminately deletes a patient from the system.

This will wipe the all of the patients records from PatientPal.\nThis action cannot be undone.

This should not be done for live patients, as that could violate HIPPA compliance requiring records to be kept for seven years. This is mostly used for deleting test patients and mistakes.

The Patient UUID.

\n","type":"text/plain"},"type":"string","value":"{{PATIENT_ID}}","key":"id"}]}},"response":[],"_postman_id":"0c521138-507e-42d3-a989-3ee671910a13"},{"name":"Get Patient Documents","event":[{"listen":"test","script":{"id":"6e09bdca-eca2-4c80-872e-cac6eccbe90b","exec":[""],"type":"text/javascript"}}],"id":"24d403d1-038d-1f74-c8eb-96eb7b606f71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/patients/:id/documents?types=intakes,eligibilities","description":"

Get patient documents

Optional. Specify which types of documents you're requesting.

Supported types:

intakes
eligibilities
transactions

Can specify multipel types by joining the types with a comma (,). Example:

intakes,eligibilities

\n","type":"text/plain"},"key":"types","value":"intakes,eligibilities"}],"variable":[{"description":{"content":"

The Patient's UUID.

\n","type":"text/plain"},"type":"string","value":"{{PATIENT_ID}}","key":"id"}]}},"response":[],"_postman_id":"24d403d1-038d-1f74-c8eb-96eb7b606f71"},{"name":"Upload Patient Documents","event":[{"listen":"test","script":{"id":"6e09bdca-eca2-4c80-872e-cac6eccbe90b","exec":[""],"type":"text/javascript"}}],"id":"d2b221be-c5dd-40fb-bb23-64902202957d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"name\": \"file name.png\",\n\t\t\"dataURL\": \"data:base64,…\"\n\t}\n]"},"url":"https://api.patientpal.io/patients/:id/documents","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]},"isInherited":true,"source":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","type":"collection"}},"urlObject":{"path":["patients",":id","documents"],"host":["https://api.patientpal.io"],"query":[],"variable":[{"description":{"content":"

The Patient's UUID.

\n","type":"text/plain"},"type":"string","value":"{{PATIENT_ID}}","key":"id"}]}},"response":[],"_postman_id":"d2b221be-c5dd-40fb-bb23-64902202957d"},{"name":"Get Patient Intakes","event":[{"listen":"test","script":{"id":"6e09bdca-eca2-4c80-872e-cac6eccbe90b","exec":["var response = JSON.parse(responseBody);","","tests[\"is success\"] = response.success === true;",""],"type":"text/javascript"}}],"id":"06ca158e-ebf8-4f8e-9234-dea7a1df93f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/clinician/patient/:id/intakes?status=S","description":"

Get patient intakes

Optional. Filter intakes by the intake status.

Intake statuses:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Descroption
P	Pending. Intake has been started, but not submitted.
S	Submitted. Intake was submitted by the patient.
C	Confirmed. Intake has been confirmed.
Y	Synced. Intake has been synced to the EMR.

","type":"text/plain"},"key":"status","value":"S"}],"variable":[{"description":{"content":"

The Patient's UUID.

\n","type":"text/plain"},"type":"string","value":"{{PATIENT_ID}}","key":"id"}]}},"response":[],"_postman_id":"06ca158e-ebf8-4f8e-9234-dea7a1df93f1"}],"id":"0a8b3cde-1203-4605-8089-f01dd803dca7","description":"

Schemas

NameSchema

A NameSchema object is a patient name, stored as an object. The object contains the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
prefix	Prefix, commonly: MR, MRS, MS, DR, PHD, MD, PROF.
given	Patient's given name, aka first name.
middle	Patient's middle name or initial.
family	Patient's family name, aka last name.
suffix	Suffix, commonly: JR, II, III, IX.
nick	Patient's nickname or preferred name.

None of the fields are required. All values are stored in unicode uppercase.

Example

{\n    \"prefix\": \"MR\",\n    \"given\": \"SAMUEL\",\n    \"nick\": \"SAM\",\n    \"middle\": \"LEROY\",\n    \"family\": \"JACKSON\"\n}\n

PhonesSchema

A PhonesSchema is an array of phone objects.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`n` (*)	Phone number, stored in E.164 format.
`e`	Phone extension.
`t`	Phone type. Usually pulled from EMR. Usually cannot be trusted. Possible values: `FAX`, `CELL`, `HOME`, `WORK`, `WORKFAX`, `HOMEFAX`
`ut`	Untextable. When true, this number cannot receive texts, usually due to the number being a landline. We determine this after the first time we've attempted to send a text, are mark a number as untextable when we do not receive delivery confirmation.
`uf`	Unfaxable. When true, this number cannot receive faxes.
`uc`	Uncallable. When true, this number cannot receive phone calls. This may indicate the patient has blocked our auto-dailer.

Example

[\n    { \"n\": \"+18005551234\", \"e\": \"700\", \"t\": \"WORK\", \"ut\": true },\n    { \"n\": \"+12345679001\", \"t\": \"CELL\" }\n]\n

","event":[{"listen":"prerequest","script":{"id":"a4ad2cfb-3ed6-412b-abc2-066083d67dee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a846740d-e751-49a0-865c-1c6bf240f922","type":"text/javascript","exec":[""]}}],"_postman_id":"0a8b3cde-1203-4605-8089-f01dd803dca7","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]},"isInherited":true,"source":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","type":"collection"}}},{"name":"Eligibilities","item":[{"name":"Pull Eligibility & Benefits","event":[{"listen":"test","script":{"id":"6e09bdca-eca2-4c80-872e-cac6eccbe90b","exec":[""],"type":"text/javascript"}}],"id":"1ff72f88-8969-4047-8450-4fdb48565017","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"patient\": \"{{PATIENT_ID}}\",\n \"carrier\": \"Insurance Carrier/Provider/Payer ID\",\n \"carrierLookup\": \"Optionally specifiy the clinic's Carrier Lookup ID\",\n \"appointment\": \"PatientPal Appointment ID\",\n \"insuranceType\": \"Optionally specify P|S|T for Primary, Secondary, or Tertiary\",\n \"memberId\": \"Member Number (Conditionally optional, depends on the Insurance Carrier)\",\n \"groupNumber\": \"Group Number (Optional)\",\n \"dob\": \"Specify the Date of Birth for the patient, as YYYY-MM-DD (Optional). Defaults to the patient's DOB on the Patient Record when available.\",\n \"dateOfService\": \"Specify Date of Service for the request, as YYYY-MM-DD. If you want to explicitly not provide a Date of Service, provide 'unspecified' as a string.\",\n \"sex\": \"Specify the Sex for the patient as M|F|O (Male|Female|Other) (Optional). Deafults to the patient's Sex on the Patient Record when available.\",\n \"callbackUrl\": \"Optionally provide a callback url, e.g.: https://api.myservice.com/patientpal_eligibility_response\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.patientpal.io/eligibilities","description":"

Attempt to pull a patient's eligibility and benefits from the specified payer, carrier.

If you specify appointment, the eligibility will apply to the appointment automatically. If enabled, PatientPal will automatically create an estimate based on the updated the information. If enabled, PatientPal will convert the estimate to an invoice automatically if the confidence interval allows it.

The memberId and groupNumber fields are optional, when both are not used we automatically attempt to use the patient's date of birth only. Some payers require a memberId, the request will automatically fail when it's required and not specified.

Eligibility requests are asynchronous. When successful, PatientPal will respond with a 202 status, Accepted. To have PatientPal push a response to a callback URL, specify your callback with callbackUrl. The callbackUrl must be an HTTPS endpoint with a valid SSL certificate, otherwise the callback will fail.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]},"isInherited":true,"source":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","type":"collection"}},"urlObject":{"path":["eligibilities"],"host":["https://api.patientpal.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ff72f88-8969-4047-8450-4fdb48565017"},{"name":"Get Eligibility Details","event":[{"listen":"test","script":{"id":"6e09bdca-eca2-4c80-872e-cac6eccbe90b","exec":[""],"type":"text/javascript"}}],"id":"0b8c10d7-48aa-49ec-a4cf-d4cd4efbe4ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/eligibilities/:id","description":"

Get the details for a specified eligibility response.

PatientPal supports pulling eligibilities from several clearinghouses, including Change Healthcare, PokitDok, and Availity. The responses from those clearinghouses are standardized into a PatientPal Generic Eligibility Response format. In addition, PatientPal will read the benefits information provided and determine the applicable benefits based on the appointment's procedures. These items will be represented in the selectedCoverageItems object.

If any errors are encountered, PatientPal will standardize the X12 error codes received high human-readable error messages.

PatientPal Eligibility ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"0b8c10d7-48aa-49ec-a4cf-d4cd4efbe4ab"},{"name":"Get Eligibility PDF","event":[{"listen":"test","script":{"id":"a371d7f4-a0aa-4618-8b17-49b1939e917f","exec":[""],"type":"text/javascript"}}],"id":"dc3bbbb6-db79-44e1-b361-ecae3a4b744d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/eligibilities/:id/pdf","description":"

Get the eligibility and benefits as a PDF or HTML.

When a PDF is requested, PatientPal will response with a standardized PDF Redirect Response.

PatientPal Eligibility ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"dc3bbbb6-db79-44e1-b361-ecae3a4b744d"},{"name":"Get Patient Eligibilities","event":[{"listen":"test","script":{"id":"d9b2ac89-441e-4b85-9ae3-4a4ce3880b12","exec":[""],"type":"text/javascript"}}],"id":"1827be83-5e15-44e9-89eb-1f189fbe2ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.patientpal.io/eligibilities/patients/:patientId","description":"

Get a list of all the eligibilities pulled for a patient. By default, this will include invalid and inactive eligibility requests.

PatientPal Patient ID

\n","type":"text/plain"},"type":"any","value":"","key":"patientId"}]}},"response":[],"_postman_id":"1827be83-5e15-44e9-89eb-1f189fbe2ac9"}],"id":"04934fa9-7d2a-49cb-b169-0760487b6124","_postman_id":"04934fa9-7d2a-49cb-b169-0760487b6124","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]},"isInherited":true,"source":{"_postman_id":"e5b84716-a293-7cf5-4970-75f4a1799f76","id":"e5b84716-a293-7cf5-4970-75f4a1799f76","name":"PatientPal","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"redirect_uri","value":""},{"key":"grant_type","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"accessTokenUrl","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"d7c57bf1-ecd4-4d5a-904b-cafc3a64f8a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2a4a4884-5ce5-4b29-ab35-fcc02228fdbe","type":"text/javascript","exec":[""]}}],"variable":[{"key":"HOST","value":"https://api.patientpal.io"},{"key":"AUTH_TOKEN","value":""},{"key":"API_KEY","value":""},{"key":"API_SECRET","value":""}]}