Given an OAuth 2 application authorized with Client Credentials, and an Athena appointment_id and department_id, a third party application can embed Epion’s PreVisit workflow with customized UI within their apps, by:
The API allows up to 20 connections per second (1,200 per minute). Above that, it responds with a 429 Too Many Requests error, including a retry-after HTTP header to inform clients.
Authenicate your application with the Epion API. Requires credentials provided by Epion, the credentials below are just examples.
\n","event":[{"listen":"prerequest","script":{"id":"25b18998-23bc-420a-87bc-3381fa05dc4d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e6d8d445-b128-4438-a053-a64454c545c3","type":"text/javascript","exec":[""]}}],"_postman_id":"0e09180d-bbe5-4a1d-bb81-ecb9c6fe8c8b"},{"name":"Get PreVisit Session URL","item":[{"name":"/api/v1/previsit/session","event":[{"listen":"test","script":{"id":"513d1805-8927-4ec8-a39f-d4050ba8d888","exec":["tests[\"Status code is 200 Created\"] = responseCode.code === 200;","","if (responseCode.code === 200)","{"," var data = JSON.parse(responseBody);"," postman.setEnvironmentVariable(\"next_step_url\", data.next_step_url); "," tests[\"previsit link = \" + data.next_step_url] = true;","}"],"type":"text/javascript","packages":{}}}],"id":"06ebbb56-f485-41c7-beac-3361f4ea590f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[],"url":"{{base_path}}/api/v1/previsit/session?appointment_id=1123549&department_id={{department}}&api_redirect_uri=https://www.epionhealth.com/","description":"You can use the api_redirect_uri parameter to redirect back to your application once the PreVisit is completed.
This parameter is optional
\n","type":"text/plain"},"key":"api_redirect_uri","value":"https://www.epionhealth.com/"}],"variable":[]}},"response":[{"id":"50927264-7f9f-4eec-829f-0c2e702e5a15","name":"Start a PreVisit session + api redirect uri","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_path}}/api/v1/previsit/session?appointment_id=408922&department_id=165&api_redirect_uri=https://www.epionhealth.com/","host":["{{base_path}}"],"path":["api","v1","previsit","session"],"query":[{"key":"appointment_id","value":"408922"},{"key":"department_id","value":"165"},{"key":"api_redirect_uri","value":"https://www.epionhealth.com/"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Nov 2020 21:09:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"38914231885fb872371cc7d78c32f86e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_patient-check-in_session=AGrCq68jnAs4RiSyfu2NEvJeAe7S5DQj6kAozSdu%2B0O24UA8ehFsDcoKfb1SmaaLpFkz%2BMnEaFzw36qVyE2iDuzH3yoloLOI0zHw5hxAeQpSf%2BK1ztonXec%2BNENKsJZRVgGJOn92fUjBKzrSk%2FV4buK5qoGTba5NDfg1bd3eE4FKJrAu16UEr7qnamkbM99hhxzPVawVZsadEWC8LxKZiOZ%2FE8llIboLprJjUk3V0G5UoQu5P4Cb5T%2BnInRdGGwt3%2FAmiEPYIoY%2FyUdjVbDF724H6PMudbcR2n1w29ilQHSPER%2F3oyNBlUjvZuWFqdY%3D--%2BVEetgTmV585Kt0L--qOzpR%2FJbt0wsq9E66LGBMQ%3D%3D; path=/; expires=Thu, 05 Nov 2020 21:39:04 GMT; secure; HttpOnly"},{"key":"X-Request-Id","value":"a24901a7-572b-4e27-9550-9089112743b8"},{"key":"X-Runtime","value":"0.365626"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"next_step_url\": \"https://testing.epionhealth.com/api/v1/previsit/session/secured?t=eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7ImFwcHRfaWQiOiI0MDg5MjIiLCJ1cmkiOiJodHRwczovL3d3dy5lcGlvbmhlYWx0aC5jb20vIiwib2ZmaWNlX2lkIjoxMDh9LCJleHAiOjE2MDQ2MTA2MDR9.3a6g7wAFzeZEFhPANhZMOkN97bDQfF_KX0nIevCULR0\"\n}"}],"_postman_id":"06ebbb56-f485-41c7-beac-3361f4ea590f"}],"id":"19c55c31-dbb2-4b30-9089-4cd07e501a5c","description":"Given appointment_id and department_id, it returns a URL with an expiring JSON Web Token (JWT). If you redirect the patient to that URL, they will be automatically authenticated into their PreVisit session.
Given the JSON Web Token (JWT) from the previous request, set the cookie for the patient and redirect to the first step of the PreVisit workflow.
\n","event":[{"listen":"prerequest","script":{"id":"21a50285-1b0e-48d1-b82b-436422b3fd05","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1b47e5f5-56c6-44cf-a703-3bb3a60ca66d","type":"text/javascript","exec":[""]}}],"_postman_id":"bd6f4156-d78a-4ce8-bff3-b1f30310fe71"},{"name":"Query Appointment Status","item":[{"name":"/api/v1/previsit/session","event":[{"listen":"test","script":{"id":"3d7af0b9-495d-410a-b03e-230f5cea6e88","exec":["tests[\"Status code is 200 Created\"] = responseCode.code === 200;","","if (responseCode.code === 200)","{"," var data = JSON.parse(responseBody);"," if (data.appointment_status === \"f\"){"," tests[\"appointment status is FUTURE \"] = true;"," }"," if (data.appointment_status === \"2\"){"," tests[\"appointment status is CHECK-IN STARTED\"] = true;"," }"," if (data.appointment_status === \"3\"){"," tests[\"appointment status is CHECKED OUT\"] = true;"," }","}",""],"type":"text/javascript","packages":{}}}],"id":"5e35bf3e-8e55-4115-9bad-cc83b01c5fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{base_path}}/api/v1/previsit/session?appointment_id=1123549&department_id={{department}}","urlObject":{"path":["api","v1","previsit","session"],"host":["{{base_path}}"],"query":[{"key":"appointment_id","value":"1123549"},{"key":"department_id","value":"{{department}}"}],"variable":[]}},"response":[{"id":"b14f7477-dae7-4720-a916-971f47752b0f","name":"Valid IDs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_path}}/api/v1/previsit/session?appointment_id=408922&department_id=165","host":["{{base_path}}"],"path":["api","v1","previsit","session"],"query":[{"key":"appointment_id","value":"408922"},{"key":"department_id","value":"165"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Nov 2020 21:07:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"7aae38bd2e32975c351f5937c8b43f6f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_patient-check-in_session=qUfsjW8VImFV%2FOZgC0nvCQd%2B7ayV2exUfrczu7flvqCoGzDPzF%2BsxrLWeblM6MjtH27kmiAy%2B18Ea6yfcTC%2BQLwwJmobrQ2LX9HwfVgKYQgt5hpPb38LLZECcbQzbes%2B%2F%2BohkuGl19YvkHO%2B7oOt%2Fzqb45SLEkWkOCa7PWuLXox24FuMedcGKY6KhYGP5yN%2FnCFdhRHnFs84rLrscCTiNoW9%2FapBJ51DyEpRZw8WNZV2Rz41uB3p%2BqgGAmmtb3hV2Wx4%2B2JeY%2FmMC3QcLPiqzxgRcMQzMuz03sc%2BxAuIZus5zE7aTStbTW3uwf9zNec%3D--OL3cawN82%2FlMmggJ--lWp77YlISfpVF8ssUWbzPA%3D%3D; path=/; expires=Thu, 05 Nov 2020 21:37:54 GMT; secure; HttpOnly"},{"key":"X-Request-Id","value":"044b6860-717c-4c9f-9fc9-f3cf23563b13"},{"key":"X-Runtime","value":"0.433380"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"appointment_id\": 408922,\n \"appointment_start_time\": \"2020-08-18T23:59:00.000Z\",\n \"appointment_status\": \"f\",\n \"previsit_completed_at\": \"2020-09-02T15:51:52.965Z\",\n \"previsit_id\": 99288\n}"}],"_postman_id":"5e35bf3e-8e55-4115-9bad-cc83b01c5fc8"}],"id":"3916ad23-07d4-4dff-9d97-7d80d42edd79","description":"Given an appointment_id and department_id, returns the appointment_status and a previsit_id. You do not need to store or use the previsit_id, we include it for debugging purposes.
You can use the api_redirect_uri parameter to redirect back to your application once the Kiosk session is completed.
Athena id of intended department to initiate the session for (required)
\n","type":"text/plain"},"key":"department_id","value":"{{department}}"},{"description":{"content":"Athena id of intended patient to initiate the session for (required)
\n","type":"text/plain"},"key":"patient_id","value":"26050"},{"description":{"content":"Uri to redirect to once patient completes their Kiosk session. This parameter is optional.
\n","type":"text/plain"},"key":"api_redirect_uri","value":"https://www.epionhealth.com/"},{"key":"is_new_patient","value":"true"}],"variable":[]}},"response":[{"id":"26969b4c-8f61-4bfc-a8d4-e2d54dc37de5","name":"Start a Mobile Kiosk session + api redirect uri","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_path}}/api/v1/kiosk/session?department_id=148&patient_id=26050&api_redirect_uri=https://www.epionhealth.com/","host":["{{base_path}}"],"path":["api","v1","kiosk","session"],"query":[{"key":"department_id","value":"148","description":"Athena id of intended department to initiate the session for (required)"},{"key":"patient_id","value":"26050","description":"Athena id of intended patient to initiate the session for (required)"},{"key":"api_redirect_uri","value":"https://www.epionhealth.com/","description":"uri to redirect to once patient completes their Kiosk session","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"next_step_url\": \"https://testing.epionhealth.com/api/v1/kiosk/session/secured?t=eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InByZXZpc2l0X2lkIjoxMzF9LCJleHAiOjE2NTQ1NDgxMTB9.l1clbtfCjbsmLc1Qp24vWm7w--E1WdaTIsLS9eJW8U8\"\n}"}],"_postman_id":"1a2ba999-00e4-44e2-9ec0-2d75158e57a4"},{"name":"api/v1/kiosk/session Copy","event":[{"listen":"test","script":{"id":"c3eaa01c-88d1-49ee-9cd6-441c419c1936","exec":["tests[\"Status code is 200 Created\"] = responseCode.code === 200;","","if (responseCode.code === 200)","{"," var data = JSON.parse(responseBody);"," postman.setEnvironmentVariable(\"next_step_url\", data.next_step_url); "," tests[\"previsit link = \" + data.next_step_url] = true;","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4bdec633-70a7-4e42-b9e9-2fec7d3ae9de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[],"url":"{{base_path}}/api/v1/kiosk/session?department_id={{department}}&patient_id=87472&api_redirect_uri=https://www.epionhealth.com/&is_new_patient=true","description":"You can use the api_redirect_uri parameter to redirect back to your application once the Kiosk session is completed.
Given patient_id and department_id, it returns a URL with an expiring JSON Web Token (JWT). If you redirect the patient to that URL, they will be automatically authenticated into their Mobile Kiosk session.
Given the JSON Web Token (JWT) from the previous request, set the cookie for the patient and redirect to the first step of the Mobile Kiosk workflow.
\n","_postman_id":"05977cf2-96f7-4ffa-92b9-e4fc92eea28f"},{"name":"Get Virtual Registration Session URL","item":[{"name":"api/v1/virtual_registration/session","event":[{"listen":"test","script":{"id":"4143352f-e888-40da-ab17-b3438e681be0","exec":["tests[\"Status code is 200 Created\"] = responseCode.code === 200;","","if (responseCode.code === 200)","{"," var data = JSON.parse(responseBody);"," postman.setEnvironmentVariable(\"next_step_url\", data.next_step_url); "," tests[\"previsit link = \" + data.next_step_url] = true;","}"],"type":"text/javascript"}}],"id":"2f97841e-d4ac-4000-8cf1-2bfa1ebdb6d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[],"url":"{{base_path}}/api/v1/virtual_registration/session?patient_id=26050&api_redirect_uri=https://www.epionhealth.com/","description":"You can use the api_redirect_uri parameter to redirect back to your application once the Kiosk session is completed.
Athena id of intended patient to initiate the session for (required)
\n","type":"text/plain"},"key":"patient_id","value":"26050"},{"description":{"content":"Uri to redirect to once patient completes their Virtual Registration session. This parameter is optional.
\n","type":"text/plain"},"key":"api_redirect_uri","value":"https://www.epionhealth.com/"}],"variable":[]}},"response":[{"id":"994be212-2aec-4d4a-9e54-6648275b6c3a","name":"Start a Mobile Kiosk session + api redirect uri","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_path}}/api/v1/virtual_registration/session?patient_id=26050&api_redirect_uri=https://www.epionhealth.com/","host":["{{base_path}}"],"path":["api","v1","virtual_registration","session"],"query":[{"key":"patient_id","value":"26050","description":"Athena id of intended patient to initiate the session for (required)"},{"key":"api_redirect_uri","value":"https://www.epionhealth.com/","description":"uri to redirect to once patient completes their Kiosk session"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"next_step_url\": \"https://testing.epionhealth.com/api/v1/virtual_registration/session/secured?t=eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InByZXZpc2l0X2lkIjoxMzF9LCJleHAiOjE2NTQ1NDgxMTB9.l1clbtfCjbsmLc1Qp24vWm7w--E1WdaTIsLS9eJW8U8\"\n}"}],"_postman_id":"2f97841e-d4ac-4000-8cf1-2bfa1ebdb6d7"}],"id":"063a4c56-b04b-475c-aec1-f0e63a08c1e2","description":"Given patient_id, it returns a URL with an expiring JSON Web Token (JWT). If you redirect the patient to that URL, they will be automatically authenticated into their Virtual Registration session.
Athena id of intended patient to retrieve virtual registrations for (required)
\n","type":"text/plain"},"key":"patient_id","value":"26030"}],"variable":[]}},"response":[],"_postman_id":"1629604d-dfa9-4377-9983-9f588fba6d82"}],"id":"d5a89c35-f4bc-4eec-ae36-a869b6ce928b","description":"Given patient_id, it returns the department id for each active (non-expired) virtual registration available in the Epion system associated to the patient.
Given the JSON Web Token (JWT) from the previous request, set the cookie for the patient and redirect to the first step of the Virtual Registration workflow.
\n","_postman_id":"0a4e0c41-88f5-443f-a0fc-e8cd47993c70"}],"event":[{"listen":"prerequest","script":{"id":"9a8b9d87-9083-4732-94c9-af1309748b93","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f2478531-961e-424b-b48b-faebaa0d051f","type":"text/javascript","exec":[""]}}]}