Skip to content
This repository was archived by the owner on Oct 10, 2023. It is now read-only.

Commit 1e490b2

Browse files
thetechwitchthetechwitch
committed
enh(index): updates to wording, added create intake example JSON, added header for auth token
1 parent d3ec26f commit 1e490b2

File tree

1 file changed

+74
-12
lines changed

1 file changed

+74
-12
lines changed

‎index.html

Lines changed: 74 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ <h1>Getting Started</h1>
187187
<div class="row">
188188
<div class="col-6">
189189
<p>
190-
This document outlines the behaviors expected from Intake API Version 2 (V2). The Workpath REST API provides programmatic access to
190+
This document outlines the behaviors expected from Workpath's API for creating intakes and appointments. In Workpath, intakes are pre-appointment requests - incomplete data objects, and appointments are data objects used to track logistics for the patient, specimen, and specialist. The Workpath REST API provides programmatic access to
191191
Workpath data for use in client applications and partner integrations. This is a working document as we continue to update our API.
192192
</p>
193193
<p>
@@ -196,13 +196,12 @@ <h1>Getting Started</h1>
196196
</p>
197197
<h4>Information We Need</h4>
198198
<p>
199-
To start the appointment process, we require a certain amount of information from you about your patient, the provider of your
200-
patient, what labs you are wanting to run, and insurance information (if applicable). See the sections below about our endpoints you
199+
To start the appointment process, we require a certain amount of information from you to complete the appointment including contact and location information for your patient and what labs/tests you want to complete. In some cases, you may need to provide information on Providers, patient payment/insurance information, and other specimen-related data; if you think you may need assistance with this information, click <a href="https://help.workpath.co/en/" target="blank">here</a>. See the sections below about our endpoints you
201200
will need in order to create a full appointment.
202201
</p>
203202
<p>
204-
Access to our Client Management Dashboard can be found
205-
<a href="https://api.workpath.co/clients" target="blank">here</a>.
203+
Access to our Client Management Dashboard where you can review your auth methods and keys can be found
204+
<a href="https://api.workpath.co/clients" target="blank">here</a> after we create your environment and accounts.
206205
</p>
207206
</div>
208207
</div>
@@ -340,7 +339,7 @@ <h3>3. Create an Intake</h3>
340339
<div class="row">
341340
<div class="col-6">
342341
<p>
343-
Using the access token that you requested in step two, you will then be able to create what we can an Intake! An intake will, in turn, create an appointment once the patient has filled out all of the required fields and submitted their response.
342+
Using the access token that you requested in step two, you will then be able to create what we call an Intake! An intake will, in turn, create an appointment once the patient or provider has filled out all of the required fields and submitted their response.
344343
</p>
345344
<p>
346345
The Create Intake details, such as request attributes and response JSON objects, are located <a href="#CreateIntake">HERE</a> in these docs.
@@ -744,6 +743,20 @@ <h5>Example Response JSON</h5>
744743
</pre>
745744
</div>
746745
</div>
746+
<div class="row">
747+
<div class="col-6">
748+
<h4>Authenticating with Your Token</h4>
749+
<p>
750+
The access token returned by the token exchanges listed above are used as the bearer token for all subsequent requests to the API in the form of an auth header (<code>Authorization: Bearer [access token]</code>). Subsequent requests made using an expired or invalid token will return a <code>401 - Unauthorized response code</code>.
751+
</p>
752+
</div>
753+
</div>
754+
<div class="row">
755+
<div class="col-6">
756+
<h5>Headers</h5>
757+
<p><code>Authorization: Bearer ut11023123...</code></p>
758+
</div>
759+
</div>
747760
<div class="row">
748761
<div class="col">
749762
<p>Need additional assistance? <a href="https://help.workpath.co/en/" target="blank">Click Here</a></p>
@@ -1177,7 +1190,7 @@ <h1>People</h1>
11771190
<div class="row">
11781191
<div class="col-6">
11791192
<p>
1180-
These are the endpoints you will need to hit in order to create a Patient, Guarantor, and an Insured Person for the Insurance Object
1193+
In most cases, you will create your patient when submitting an intake. If not, these are the endpoints you will need to hit in order to create a Patient, Guarantor, and an Insured Person for the Insurance Object
11811194
later on.
11821195
</p>
11831196
</div>
@@ -1864,7 +1877,7 @@ <h1>Payment Object</h1>
18641877
<div class="row">
18651878
<div class="col-6">
18661879
<p>
1867-
If you do not know this information, simply send us an empty object and we will request the information from your patient directly.
1880+
While we do not process payments through Workpath, we can pass that information to be included for a lab to review. If you do not know this information, simply send us an empty object and we will request the information from your patient. We will not ask for credit card or other ACH payment information from a patient, but can pass information like Insurance Group Number to a lab partner where needed.
18681881
</p>
18691882
</div>
18701883
</div>
@@ -2104,7 +2117,10 @@ <h1>Intakes</h1>
21042117
<div class="row">
21052118
<div class="col-6">
21062119
<p>
2107-
The Intake is the starting point for a patient request. The initial call takes in certain parameters about the patient and the service being ordered and, depending on the Order Form that is specified, sends a request to the patient (via email and/or SMS) for additional information.
2120+
The Intake is the starting point for an appointment, and will trigger a patient request and other validations for ensuring Workpath has all necessary information for your patient’s appointment. The initial call takes in certain parameters about the patient and the service being ordered and, depending on the Order Form that is specified, sends a request to the patient (via email and/or SMS) for additional information.
2121+
</p>
2122+
<p>
2123+
Before you get started with sending your Intakes, make sure you work with Workpath’s Customer Success team to set up your mock input forms, fields, and expected behavior so we can simulate the request and process as close to the future state.
21082124
</p>
21092125
</div>
21102126
</div>
@@ -2128,10 +2144,10 @@ <h4>Patient Requests</h4>
21282144
</p>
21292145
<ul style="list-style-type: circle;">
21302146
<li>
2131-
If the Order Form is set to <strong>Auto-Publish</strong>, the Intake will be automatically converted to an Appointment.
2147+
If Workpath has set <strong>auto-convert</strong> for your organization, the Intake will automatically be converted to an Appointment and released to the Workpath Network.
21322148
</li>
21332149
<li>
2134-
If not, the Intake will populate within the "New" tab of the <strong>Service Requests</strong> tab on the web app. An Office User can then verify the Intake and convert it to an Appointment.
2150+
If not, the Intake will populate within the "Pending Patient Request" tab of the <strong>Pending Appointments</strong> page on the web app. Once the patient responds, an Office User can then verify the Intake and convert it to an Appointment for release.
21352151
</li>
21362152
</ul>
21372153
</div>
@@ -2566,6 +2582,7 @@ <h5>Request Attributes</h5>
25662582
<tr>
25672583
<td>
25682584
<p class="cell"><code class="attribute">order_form</code> <code>integer</code></p>
2585+
<p class="small">required</p>
25692586
</td>
25702587
<td>The unique ID of the Order Form that is attached to this Intake</td>
25712588
</tr>
@@ -2646,6 +2663,7 @@ <h5>Request Attributes</h5>
26462663
<tr>
26472664
<td>
26482665
<p class="cell"><code class="attribute">first_name</code> <code>string</code></p>
2666+
<p class="small">required</p>
26492667
</td>
26502668
<td>The Patient's legal first name</td>
26512669
</tr>
@@ -2658,18 +2676,21 @@ <h5>Request Attributes</h5>
26582676
<tr>
26592677
<td>
26602678
<p class="cell"><code class="attribute">last_name</code> <code>string</code></p>
2679+
<p class="small">required</p>
26612680
</td>
26622681
<td>The Patient's legal last name</td>
26632682
</tr>
26642683
<tr>
26652684
<td>
26662685
<p class="cell"><code class="attribute">phone</code> <code>string</code></p>
2686+
<p class="small">required</p>
26672687
</td>
26682688
<td>The Patient's phone number</td>
26692689
</tr>
26702690
<tr>
26712691
<td>
26722692
<p class="cell"><code class="attribute">email</code> <code>string</code></p>
2693+
<p class="small">required</p>
26732694
</td>
26742695
<td>The Patient's email address</td>
26752696
</tr>
@@ -2710,6 +2731,7 @@ <h5>Request Attributes</h5>
27102731
<tr>
27112732
<td>
27122733
<p class="cell"><code class="attribute">services</code> <code>array of objects</code></p>
2734+
<p class="small">required</p>
27132735
</td>
27142736
<td>
27152737
<p class="cell">The requested services and their related ICD-10 codes</p>
@@ -2896,6 +2918,44 @@ <h5>Request Attributes</h5>
28962918
</tbody>
28972919
</table>
28982920
</div>
2921+
2922+
<div class="col-6">
2923+
<h5>Example Intake Request JSON</h5>
2924+
<pre>
2925+
<code>
2926+
{
2927+
"order_form": 1, // required
2928+
"provider": {
2929+
"first_name": "Bruce",
2930+
"last_name": "Banner",
2931+
"npi": "0101010111"
2932+
},
2933+
"patient": {
2934+
"first_name": "Anthony", // required
2935+
"last_name": "Stark", // required
2936+
"gender": "male",
2937+
"phone": "+18048675309", // required
2938+
"email": "tony@starkindustries.com", // required
2939+
"messaging_enabled_sms": true
2940+
},
2941+
"services": [ // required
2942+
{ "id": 12312 },
2943+
{ "id": 91232 }
2944+
],
2945+
"start_time": "2021-06-20T13:00:00Z",
2946+
"location": {
2947+
"street": "200 Park Avenue",
2948+
"street2": "The Top",
2949+
"city": "New York",
2950+
"state": "New York",
2951+
"zip": "10166",
2952+
"country": "US"
2953+
},
2954+
"notes": "Patient has fusion reactor in chest."
2955+
}
2956+
</code>
2957+
</pre>
2958+
</div>
28992959
</div>
29002960
<div class="row">
29012961
<div class="col">
@@ -4286,7 +4346,9 @@ <h5>Request Parameters</h5>
42864346
<div class="col-6">
42874347
<h4>Add Note to Appointment</h4>
42884348
<p><code>POST https://api.workpath.co/appointments/[id]/notes</code></p>
4289-
<p>Apply note to an appointment. Requires “Update appointment details” permission.</p>
4349+
<p>
4350+
Apply note to an appointment. Requires “Update appointment details” permission. Workpath uses and displays different types of notes depending on the user, status, and context; work with our Workpath Customer Success team to identify the ideal note type and contents for your workflow.
4351+
</p>
42904352
</div>
42914353
</div>
42924354
<div class="row">

0 commit comments

Comments
 (0)