Overview

Profile Scope

Resource Summary

Doctor Resource

Patient Resource

Appointment Resource

Specialization Resource

Search

/profile/patient

/profile/doctor

/doctor

<h1>Doctor</h1>
<p>Boldo Doctor implements the iHub Doctor model and adds information relevant for availability.</p>
<h2>Endpoints</h2>
<p>The Doctor Resource provides the following endpoints:</p>
<ul>
<li><strong>Get /doctors</strong></li>
<li><strong>Get /doctors/:id</strong></li>
<li><strong>Get /doctors/:id/availability</strong></li>
</ul>
<hr>
<h3>List Doctors</h3>
<p>Search for Doctors and List Results.</p>
<pre><code>GET /doctors
</code></pre>
<p><em>Configuration is the same as iHub Resource. Addition:</em></p>
<p><strong>Return Value:</strong></p>
<ul>
<li>nextAvailability: Date</li>
</ul>
<hr>
<h3>Doctor Detail</h3>
<p>Show details of a Doctor.</p>
<pre><code>GET /doctors/:id
</code></pre>
<p><em>Configuration is the same as iHub Resource.</em></p>
<hr>
<h3>Doctor Availability</h3>
<p>Show availability of a Doctor.</p>
<pre><code>GET /doctors/:id/availability
</code></pre>
<p><strong>Access Level:</strong> <code>Public</code></p>
<p><strong>Parameters (as query params):</strong></p>
<ul>
<li>start: Date</li>
<li>end: Date</li>
</ul>
<p><strong>Return Value:</strong> Doctor Details and List of availabilities.</p>
<pre><code>{ ...doctor, availabilities: [Date, Date, ...], nextAvailability: Date }
</code></pre>
<blockquote>
<p><code>start</code> and <code>end</code> parameters are the search window for availabilities. If start is in the past, it will be set to the current time, and the distance of both dates can be maximum of 31 days.</p>
</blockquote>
