The MedHub API provides external systems with access to its database through pre-defined calls. The API is much like a standard REST interface, but with a couple of important differences.
\nFirst, MedHub uses the HTTP method “POST” for all requests, using a Content-Type of application/x-www-form-urlencoded. This provides for complex requests and garners more familiarity and support than the often unused “PUT” method.
Second, MedHub employs a verification technique that is very similar to Amazon’s AWS authentication. This process is described in detail in the \"API Requirements\" section.
\nEach institution manages access to the MedHub API through the GME Office. To request access, contact the project manager within the GME Office and provide the following information in your request.
\nCompany/System Information:
\nContact Information:
\nAccess Needs:
\nIf your request is approved, you will be provided with a clientID (integer) and a private key. These will be used to generate a verification key, which is needed for each API call. Keep the private key in a safe place and do not distribute.
This section will identify the interface requirements and process for making a call to the MedHub API. All calls should be made using HTTPS, to ensure encryption in transit.
\nAll calls should use a standard POST request and include the following variables. The Content-Type of these requests should be set as application/x-www-form-urlencoded.
clientID - Your assigned client identifier (integer)ts - Current UNIX timestamp (must be within 10 minutes of MedHub server time). Note: this timestamp should be provided in whole seconds (e.g. 1593030486 representing 6/24/2020 at 8:28pm UTC)type - This will identify the format type of the request and response. At this time, only “json” is supported.request - The JSON encoded request, which is specific to each call. Note: this is not needed or optional for some calls.verify - The unique hash which is used to verify the authenticity of the requestProcess used to generate the “verify” string.
\n{clientID}|{timestamp}|{private key}|{request}verify key.| Error Code | Error Description | Error Notes |
|---|---|---|
S01 | Request was not well formed (missing class, method, verify string, or clientID) | None |
S02 | IP Address not discoverable | None |
S03 | Invalid Client | None |
S04 | Inactive Client | None |
S05 | Client does not have access to call or this call has been deactivated | None |
S06 | Timestamp not within 10 minutes | None |
S07 | Verification string invalid | None |
S08 | Invalid requesting IP Address | Identify requesting IP address and ask GME Office to update profile |
E01 | Invalid request (class/method not found) | None |
E02 | Unsupported return type requested | None |
E03 | Access denied to this program | None |
E04 | Invalid request (unknown or malformed inputs) | None |
E05 | Requested result set is too large | This error is displayed when the requested data set is too large. Thresholds are call-specific and should be provided in the documentation above. This error can often be avoided by adding additional filters (date range, etc) |
| Status Code: | Code Description: | Notes: |
|---|---|---|
200 | OK | You should receive this code with any successful call. |
400 | Bad Request | This code will be returned if an invalid return type is requested |
401 | Unauthorized | This code will be received if there was a security/authorization-related error |
403 | Forbidden | (currently unused) |
404 | Not Found | This code identifies an unknown call |
//Client-specific settings\n$clientID='1001';\n$institution='demo';\n$privateKey='pv93bfq12eps';\n//Sample call path\n$callPath='users/residents';\n//Get UNIX timestamp\n$timeNow=time();\n//Create request\n$requestA=array('programID'=>19);\n$request_json=json_encode($requestA);\n//Generate verification string\n$verifyStr=hash('sha256',$clientID.\"|\".$timeNow.\"|\".$privateKey.\"|\".$request_json);\n//Construct data to send\n$post_dataA=array(\n 'clientID'=>$clientID,\n 'ts'=>$timeNow,\n 'verify'=>$verifyStr,\n 'type'=>'json',\n 'request'=>$request_json);\n//Request URL\n$url='https://'.$institution.'.medhub.com/functions/api/'.$callPath;\n//Initialize cURL\n$ch=curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_USERAGENT, \"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)\");\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($ch, CURLOPT_POST, 1);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post_dataA));\n//Get response data and\n$responseStr=curl_exec($ch);\n$response_infoA=curl_getinfo($ch);\n//Close session\ncurl_close($ch);\n//Display response\necho \"HTTP Status Code: <strong class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\".$response_infoA['http_code'].\"</b><BR><BR>\";\necho \"<pre class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\".htmlentities($responseStr).\"</pre>\";\necho \"<BR><BR><HR size=1><strong class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>JSON Decoded:</b><BR><BR>\";\necho '<div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' style=\"font-family: monospace; white-space:pre;\">';\necho htmlspecialchars(var_export(json_decode($responseStr,true)));\necho '</div>';\n?>\n\nno input required
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/test","description":"Test call to verify a successful connection to the api.
\n","urlObject":{"path":["info","test"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"b5f07f82-b8cb-47a2-8a6e-95b547090cbf","name":"info/test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/test"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Mar 2020 18:21:48 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\"\n}"}],"_postman_id":"72b1e88b-7a64-4024-932d-63d76ad1f661"},{"name":"info/institution","id":"ab1619a6-c562-4066-b909-3ec5758ecbc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"","description":"no input required
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/institution","description":"Retrieves information about the institution.
\n","urlObject":{"path":["info","institution"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"4fa09aed-ef33-418f-9f7b-554c3c087548","name":"info/institution","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/institution"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Mar 2020 18:24:17 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"institution_name\": \"Demo HealthCare System\",\n \"institution_abbreviation\": \"SANDBOX\",\n \"globalID\": 184,\n \"url\": \"https://sandbox.medhub.com\",\n \"api_version\": \"0.90\",\n \"rotationsetID\": 19,\n \"school_name\": \"Sandbox School of Medicine\"\n}"}],"_postman_id":"ab1619a6-c562-4066-b909-3ec5758ecbc2"},{"name":"info/medicalSchools","id":"5ba50b26-2d9c-4be0-9c65-973a799f1162","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"","description":"no input required
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/medicalSchools","description":"Retrieves information about the medical school.
\nno input required
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/status","description":"Retrieves the status of the MedHub API.
\n","urlObject":{"path":["info","status"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"83b74990-87a7-4392-a306-12f82cc42992","name":"info/status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Mar 2020 18:25:19 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"active\",\n \"time\": \"2020-03-30 02:25pm\",\n \"timestamp\": 1585592719\n}"}],"_postman_id":"a84e7bb8-ab7f-4a91-9d3b-53cb0d3b2a66"},{"name":"info/access","id":"49e70180-b771-46eb-8e3c-aab39e0919a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"","description":"no input required
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/access","description":"Retrieves a list of all calls granted to this API client by the institution.
\n","urlObject":{"path":["info","access"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"b6002f3b-d582-4efb-a0c2-3340a75e3d1b","name":"info/access","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/info/access"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 30 Mar 2020 18:26:13 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"call\": \"Conference Attendance\",\n \"call_path\": \"conferences/attendance\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the conferences attended by and individual user over a specified date range\"\n },\n {\n \"call\": \"Conference Attendance\",\n \"call_path\": \"conferences/attendance\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the conferences attended by and individual user over a specified date range\"\n },\n {\n \"call\": \"Conference Groups\",\n \"call_path\": \"conferences/groups\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the conference groups for a program\"\n },\n {\n \"call\": \"Conference Groups\",\n \"call_path\": \"conferences/groups\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the conference groups for a program\"\n },\n {\n \"call\": \"Conference Record Attendance\",\n \"call_path\": \"conferences/record\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Records attendance for a conference\"\n },\n {\n \"call\": \"Conference Record Attendance\",\n \"call_path\": \"conferences/record\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Records attendance for a conference\"\n },\n {\n \"call\": \"Conference Schedule\",\n \"call_path\": \"conferences/schedule\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the conference schedule for a program over a specified date range\"\n },\n {\n \"call\": \"Conference Schedule\",\n \"call_path\": \"conferences/schedule\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the conference schedule for a program over a specified date range\"\n },\n {\n \"call\": \"Accessible Courses\",\n \"call_path\": \"courses/access\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List of accessible courses\"\n },\n {\n \"call\": \"All Courses\",\n \"call_path\": \"courses/all\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List of all courses\"\n },\n {\n \"call\": \"Create New Course\",\n \"call_path\": \"courses/courseCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Create a new course\"\n },\n {\n \"call\": \"All Course Groups\",\n \"call_path\": \"courses/groups\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List of all course groups\"\n },\n {\n \"call\": \"Course Locations\",\n \"call_path\": \"courses/locations\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List of all active course locations\"\n },\n {\n \"call\": \"Course Parents\",\n \"call_path\": \"courses/parents\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get course parents\"\n },\n {\n \"call\": \"Delete Entry\",\n \"call_path\": \"dutyhours/delete\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Remove a work period\"\n },\n {\n \"call\": \"Delete Entry\",\n \"call_path\": \"dutyhours/delete\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Remove a work period\"\n },\n {\n \"call\": \"Post Work Period\",\n \"call_path\": \"dutyhours/post\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call is used to post a work period for resident duty hours\"\n },\n {\n \"call\": \"Post Work Period\",\n \"call_path\": \"dutyhours/post\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call is used to post a work period for resident duty hours\"\n },\n {\n \"call\": \"Violation Reasons\",\n \"call_path\": \"dutyhours/reasons\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the potential violation reasons\"\n },\n {\n \"call\": \"Violation Reasons\",\n \"call_path\": \"dutyhours/reasons\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the potential violation reasons\"\n },\n {\n \"call\": \"Duty Hour Review Periods\",\n \"call_path\": \"dutyhours/reviews\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the duty hour review periods for a specific program over a defined date range\"\n },\n {\n \"call\": \"Duty Hour Review Periods\",\n \"call_path\": \"dutyhours/reviews\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the duty hour review periods for a specific program over a defined date range\"\n },\n {\n \"call\": \"Timesheet Status\",\n \"call_path\": \"dutyhours/status\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Status of open weeks\"\n },\n {\n \"call\": \"Timesheet Status\",\n \"call_path\": \"dutyhours/status\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Status of open weeks\"\n },\n {\n \"call\": \"Submit Timesheet\",\n \"call_path\": \"dutyhours/submit\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit timesheet as complete\"\n },\n {\n \"call\": \"Submit Timesheet\",\n \"call_path\": \"dutyhours/submit\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit timesheet as complete\"\n },\n {\n \"call\": \"View Timesheets\",\n \"call_path\": \"dutyhours/timesheets\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Provides duty hour entries for a resident over a defined date range\"\n },\n {\n \"call\": \"View Timesheets\",\n \"call_path\": \"dutyhours/timesheets\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Provides duty hour entries for a resident over a defined date range\"\n },\n {\n \"call\": \"Weekly Details\",\n \"call_path\": \"dutyhours/week\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Detailed information for a calendar week\"\n },\n {\n \"call\": \"Weekly Details\",\n \"call_path\": \"dutyhours/week\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Detailed information for a calendar week\"\n },\n {\n \"call\": \"Work Types\",\n \"call_path\": \"dutyhours/workTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the duty hour work types\"\n },\n {\n \"call\": \"Work Types\",\n \"call_path\": \"dutyhours/workTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the duty hour work types\"\n },\n {\n \"call\": \"Create Enrollment Period\",\n \"call_path\": \"enrollmentperiods/periodCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Create a new enrollment period.\"\n },\n {\n \"call\": \"Delete Enrollment Period\",\n \"call_path\": \"enrollmentperiods/periodDelete\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Delete an enrollment period.\"\n },\n {\n \"call\": \"List Enrollment Periods\",\n \"call_path\": \"enrollmentperiods/periods\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get list of enrollment periods for a given course.\"\n },\n {\n \"call\": \"Update Enrollment Period\",\n \"call_path\": \"enrollmentperiods/periodUpdate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Update enrollment period information.\"\n },\n {\n \"call\": \"Create Student Enrollment Record\",\n \"call_path\": \"enrollments/enrollmentCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Create a new student enrollment record\"\n },\n {\n \"call\": \"Create Student Enrollment Record\",\n \"call_path\": \"enrollments/enrollmentCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Create a new student enrollment record\"\n },\n {\n \"call\": \"Enrollment Drop\",\n \"call_path\": \"enrollments/enrollmentDrop\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Drop a specified enrollment record\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Submit a new Grade Record\",\n \"call_path\": \"enrollments/gradeCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Submit a new Grade Record for a UME enrollment\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Get Grading Options for an enrollment record\",\n \"call_path\": \"enrollments/gradeOptions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get the final and component grading options for an enrollment record\"\n },\n {\n \"call\": \"Evaluation Forms\",\n \"call_path\": \"evals/forms\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the active evaluation forms in a program\"\n },\n {\n \"call\": \"Evaluation Forms\",\n \"call_path\": \"evals/forms\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the active evaluation forms in a program\"\n },\n {\n \"call\": \"Incomplete Evaluations\",\n \"call_path\": \"evals/incomplete\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the incomplete evaluations for a specific user\"\n },\n {\n \"call\": \"Incomplete Evaluations\",\n \"call_path\": \"evals/incomplete\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the incomplete evaluations for a specific user\"\n },\n {\n \"call\": \"Initiate Evaluation\",\n \"call_path\": \"evals/initiate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Deliver a new evaluation\"\n },\n {\n \"call\": \"Initiate Evaluation\",\n \"call_path\": \"evals/initiate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Deliver a new evaluation\"\n },\n {\n \"call\": \"Evaluation Leaderboard\",\n \"call_path\": \"evals/leaderboard\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieve the leaderboard for a specific user\"\n },\n {\n \"call\": \"Evaluation Leaderboard\",\n \"call_path\": \"evals/leaderboard\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieve the leaderboard for a specific user\"\n },\n {\n \"call\": \"Milestones List\",\n \"call_path\": \"evals/milestones\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the milestones, EPAS, or rotation objectives for a program\"\n },\n {\n \"call\": \"Milestones List\",\n \"call_path\": \"evals/milestones\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the milestones, EPAS, or rotation objectives for a program\"\n },\n {\n \"call\": \"Milestone Summary\",\n \"call_path\": \"evals/milestoneSummary\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieve the Milestone Summary for a specific user\"\n },\n {\n \"call\": \"Milestone Summary\",\n \"call_path\": \"evals/milestoneSummary\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieve the Milestone Summary for a specific user\"\n },\n {\n \"call\": \"Evaluation Post\",\n \"call_path\": \"evals/post\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Posts a new evaluation response\"\n },\n {\n \"call\": \"Evaluation Post\",\n \"call_path\": \"evals/post\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Posts a new evaluation response\"\n },\n {\n \"call\": \"Progress Reports\",\n \"call_path\": \"evals/progress\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Displays the progress report scores for a specified resident and review period\"\n },\n {\n \"call\": \"Progress Reports\",\n \"call_path\": \"evals/progress\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Displays the progress report scores for a specified resident and review period\"\n },\n {\n \"call\": \"Evaluation Questions\",\n \"call_path\": \"evals/questions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the questions for an evaluation form\"\n },\n {\n \"call\": \"Evaluation Questions\",\n \"call_path\": \"evals/questions\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the questions for an evaluation form\"\n },\n {\n \"call\": \"Remove Incomplete Evaluation\",\n \"call_path\": \"evals/remove\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Remove an evaluation for insifficuent contact\"\n },\n {\n \"call\": \"Remove Incomplete Evaluation\",\n \"call_path\": \"evals/remove\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Remove an evaluation for insifficuent contact\"\n },\n {\n \"call\": \"Evaluation Responses\",\n \"call_path\": \"evals/responses\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves completed evaluation data\"\n },\n {\n \"call\": \"Evaluation Responses\",\n \"call_path\": \"evals/responses\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves completed evaluation data\"\n },\n {\n \"call\": \"Self-Serve Evaluation Forms\",\n \"call_path\": \"evals/selfserveForms\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a list of evaluation forms that may be initiated directly by users.\"\n },\n {\n \"call\": \"Self-Serve Evaluation Forms\",\n \"call_path\": \"evals/selfserveForms\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a list of evaluation forms that may be initiated directly by users.\"\n },\n {\n \"call\": \"Evaluation Status\",\n \"call_path\": \"evals/status\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves the status of an evaluation response\"\n },\n {\n \"call\": \"Evaluation Status\",\n \"call_path\": \"evals/status\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves the status of an evaluation response\"\n },\n {\n \"call\": \"Evaluation Types\",\n \"call_path\": \"evals/types\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard evaluation types\"\n },\n {\n \"call\": \"Evaluation Types\",\n \"call_path\": \"evals/types\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard evaluation types\"\n },\n {\n \"call\": \"Call Access\",\n \"call_path\": \"info/access\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This identifies all of the calls that the current client can access\"\n },\n {\n \"call\": \"Call Access\",\n \"call_path\": \"info/access\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This identifies all of the calls that the current client can access\"\n },\n {\n \"call\": \"Information\",\n \"call_path\": \"info/institution\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Basic institution information is provided\"\n },\n {\n \"call\": \"Information\",\n \"call_path\": \"info/institution\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Basic institution information is provided\"\n },\n {\n \"call\": \"API Status\",\n \"call_path\": \"info/status\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides the status of the MedHub API\"\n },\n {\n \"call\": \"API Status\",\n \"call_path\": \"info/status\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides the status of the MedHub API\"\n },\n {\n \"call\": \"Terminology\",\n \"call_path\": \"info/terms\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Institution-specific terminology is provided\"\n },\n {\n \"call\": \"Terminology\",\n \"call_path\": \"info/terms\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Institution-specific terminology is provided\"\n },\n {\n \"call\": \"API Test\",\n \"call_path\": \"info/test\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Clients can use this simple call to test their connection to the API\"\n },\n {\n \"call\": \"API Test\",\n \"call_path\": \"info/test\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Clients can use this simple call to test their connection to the API\"\n },\n {\n \"call\": \"CME Credit Types\",\n \"call_path\": \"portfolios/cmeTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard Faculty CME credit types\"\n },\n {\n \"call\": \"CME Credit Types\",\n \"call_path\": \"portfolios/cmeTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard Faculty CME credit types\"\n },\n {\n \"call\": \"Portfolio Entry Types\",\n \"call_path\": \"portfolios/types\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard portfolio entry types\"\n },\n {\n \"call\": \"Portfolio Entry Types\",\n \"call_path\": \"portfolios/types\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard portfolio entry types\"\n },\n {\n \"call\": \"Append Diagnosis\",\n \"call_path\": \"procedures/appendDiagnosis\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Appends a diagnosis to a given procedure log.\"\n },\n {\n \"call\": \"Append Diagnosis\",\n \"call_path\": \"procedures/appendDiagnosis\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Appends a diagnosis to a given procedure log.\"\n },\n {\n \"call\": \"Append Procedure\",\n \"call_path\": \"procedures/appendProcedure\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Appends a procedure to a given procedure log.\"\n },\n {\n \"call\": \"Append Procedure\",\n \"call_path\": \"procedures/appendProcedure\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Appends a procedure to a given procedure log.\"\n },\n {\n \"call\": \"Procedure Certifications\",\n \"call_path\": \"procedures/certifications\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the procedure certifications attained by a specified resident\"\n },\n {\n \"call\": \"Procedure Certifications\",\n \"call_path\": \"procedures/certifications\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the procedure certifications attained by a specified resident\"\n },\n {\n \"call\": \"Delete Diagnosis\",\n \"call_path\": \"procedures/deleteDiagnosis\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Deletes a diagnosis from a given procedure log.\"\n },\n {\n \"call\": \"Delete Diagnosis\",\n \"call_path\": \"procedures/deleteDiagnosis\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Deletes a diagnosis from a given procedure log.\"\n },\n {\n \"call\": \"Delete Procedure\",\n \"call_path\": \"procedures/deleteProcedure\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Deletes a procedure from a given procedure log.\"\n },\n {\n \"call\": \"Delete Procedure\",\n \"call_path\": \"procedures/deleteProcedure\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Deletes a procedure from a given procedure log.\"\n },\n {\n \"call\": \"Diagnosis Counts\",\n \"call_path\": \"procedures/diagnosisCounts\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Counts the diagnoses logged by a specific resident\"\n },\n {\n \"call\": \"Diagnosis Counts\",\n \"call_path\": \"procedures/diagnosisCounts\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Counts the diagnoses logged by a specific resident\"\n },\n {\n \"call\": \"Diagnosis Requirements\",\n \"call_path\": \"procedures/diagnosisRequirements\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves diagnosis requirements for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Diagnosis Requirements\",\n \"call_path\": \"procedures/diagnosisRequirements\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves diagnosis requirements for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Diagnosis Requirements Progress\",\n \"call_path\": \"procedures/diagnosisRequirementsProgress\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves diagnosis requirement progress for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Diagnosis Requirements Progress\",\n \"call_path\": \"procedures/diagnosisRequirementsProgress\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves diagnosis requirement progress for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Diagnosis Types\",\n \"call_path\": \"procedures/diagnosisTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the diagnosis types defined by a program\"\n },\n {\n \"call\": \"Diagnosis Types\",\n \"call_path\": \"procedures/diagnosisTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the diagnosis types defined by a program\"\n },\n {\n \"call\": \"Procedure Locations\",\n \"call_path\": \"procedures/locations\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves procedure locations for a given program or course.\"\n },\n {\n \"call\": \"Procedure Locations\",\n \"call_path\": \"procedures/locations\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves procedure locations for a given program or course.\"\n },\n {\n \"call\": \"Procedure Logs\",\n \"call_path\": \"procedures/logs\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves list of logged procedures.\"\n },\n {\n \"call\": \"Procedure Logs\",\n \"call_path\": \"procedures/logs\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves list of logged procedures.\"\n },\n {\n \"call\": \"Procedure Counts\",\n \"call_path\": \"procedures/procedureCounts\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Counts the procedures logged by a specific resident\"\n },\n {\n \"call\": \"Procedure Counts\",\n \"call_path\": \"procedures/procedureCounts\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Counts the procedures logged by a specific resident\"\n },\n {\n \"call\": \"Procedure Requirements\",\n \"call_path\": \"procedures/procedureRequirements\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves procedure requirements for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Procedure Requirements\",\n \"call_path\": \"procedures/procedureRequirements\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves procedure requirements for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Procedure Requirements Progress\",\n \"call_path\": \"procedures/procedureRequirementsProgress\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves procedure requirement progress for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Procedure Requirements Progress\",\n \"call_path\": \"procedures/procedureRequirementsProgress\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves procedure requirement progress for a given user in a given program or clerkship\"\n },\n {\n \"call\": \"Procedure Types\",\n \"call_path\": \"procedures/procedureTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the procedure types defined by a program\"\n },\n {\n \"call\": \"Procedure Types\",\n \"call_path\": \"procedures/procedureTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the procedure types defined by a program\"\n },\n {\n \"call\": \"Record Log\",\n \"call_path\": \"procedures/record\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Initiate or save a procedure log.\"\n },\n {\n \"call\": \"Record Log\",\n \"call_path\": \"procedures/record\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Initiate or save a procedure log.\"\n },\n {\n \"call\": \"Procedure Roles\",\n \"call_path\": \"procedures/roles\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard procedure roles\"\n },\n {\n \"call\": \"Procedure Roles\",\n \"call_path\": \"procedures/roles\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard procedure roles\"\n },\n {\n \"call\": \"Procedure Settings\",\n \"call_path\": \"procedures/settings\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a procedure settings for a given program or course.\"\n },\n {\n \"call\": \"Procedure Settings\",\n \"call_path\": \"procedures/settings\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a procedure settings for a given program or course.\"\n },\n {\n \"call\": \"Supervision Levels\",\n \"call_path\": \"procedures/supervisionLevels\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the supervision levels defined by a program\"\n },\n {\n \"call\": \"Supervision Levels\",\n \"call_path\": \"procedures/supervisionLevels\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the supervision levels defined by a program\"\n },\n {\n \"call\": \"Procedure Supervisors\",\n \"call_path\": \"procedures/supervisors\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a list of supervisors for a program or course.\"\n },\n {\n \"call\": \"Procedure Supervisors\",\n \"call_path\": \"procedures/supervisors\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a list of supervisors for a program or course.\"\n },\n {\n \"call\": \"Procedure Supervisors Count\",\n \"call_path\": \"procedures/supervisorsCount\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a count of supervisors for a program or course.\"\n },\n {\n \"call\": \"Procedure Supervisors Count\",\n \"call_path\": \"procedures/supervisorsCount\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a count of supervisors for a program or course.\"\n },\n {\n \"call\": \"Procedure Verification History\",\n \"call_path\": \"procedures/verificationsHistory\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get procedureIDs of procedures I have verified over a given date range.\"\n },\n {\n \"call\": \"Procedure Verification History\",\n \"call_path\": \"procedures/verificationsHistory\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get procedureIDs of procedures I have verified over a given date range.\"\n },\n {\n \"call\": \"Procedure Verification History\",\n \"call_path\": \"procedures/verificationsHistory\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get procedureIDs of procedures I have verified over a given date range.\"\n },\n {\n \"call\": \"Procedure Verification History\",\n \"call_path\": \"procedures/verificationsHistory\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get procedureIDs of procedures I have verified over a given date range.\"\n },\n {\n \"call\": \"Procedure Verifications Pending\",\n \"call_path\": \"procedures/verificationsPending\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get procedureIDs of procedures waiting for my verification\"\n },\n {\n \"call\": \"Procedure Verifications Pending\",\n \"call_path\": \"procedures/verificationsPending\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Get procedureIDs of procedures waiting for my verification\"\n },\n {\n \"call\": \"Verify\",\n \"call_path\": \"procedures/verify\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Verify a Procedure\"\n },\n {\n \"call\": \"Verify\",\n \"call_path\": \"procedures/verify\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Verify a Procedure\"\n },\n {\n \"call\": \"Accessible Programs\",\n \"call_path\": \"programs/access\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides a list of programs that the current client can access\"\n },\n {\n \"call\": \"Accessible Programs\",\n \"call_path\": \"programs/access\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides a list of programs that the current client can access\"\n },\n {\n \"call\": \"All Programs\",\n \"call_path\": \"programs/all\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"All active programs in the institution are listed\"\n },\n {\n \"call\": \"All Programs\",\n \"call_path\": \"programs/all\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"All active programs in the institution are listed\"\n },\n {\n \"call\": \"Clinics\",\n \"call_path\": \"schedules/clinics\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the clinics for a program\"\n },\n {\n \"call\": \"Clinics\",\n \"call_path\": \"schedules/clinics\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the clinics for a program\"\n },\n {\n \"call\": \"Course Roster\",\n \"call_path\": \"schedules/enrollment\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List all students enrolled to a course period\"\n },\n {\n \"call\": \"Course Periods\",\n \"call_path\": \"schedules/periods\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List all enrollment periods for a course\"\n },\n {\n \"call\": \"Rotations\",\n \"call_path\": \"schedules/rotations\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the rotation periods for a schedule and year\"\n },\n {\n \"call\": \"Rotations\",\n \"call_path\": \"schedules/rotations\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the rotation periods for a schedule and year\"\n },\n {\n \"call\": \"Services\",\n \"call_path\": \"schedules/services\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the services for a program\"\n },\n {\n \"call\": \"Services\",\n \"call_path\": \"schedules/services\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the services for a program\"\n },\n {\n \"call\": \"Shift/Call Definitions\",\n \"call_path\": \"schedules/shifts\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Shift/Call definitions for a given program and year\"\n },\n {\n \"call\": \"Shift/Call Schedule\",\n \"call_path\": \"schedules/shiftsSchedule\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Shift/Call schedule data for a give date range\"\n },\n {\n \"call\": \"Schedules\",\n \"call_path\": \"schedules/view\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the schedules defined for a program and year\"\n },\n {\n \"call\": \"Schedules\",\n \"call_path\": \"schedules/view\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the schedules defined for a program and year\"\n },\n {\n \"call\": \"Academic Years\",\n \"call_path\": \"schedules/years\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the academic years\"\n },\n {\n \"call\": \"Academic Years\",\n \"call_path\": \"schedules/years\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the academic years\"\n },\n {\n \"call\": \"Accessible Schools\",\n \"call_path\": \"schools/access\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists all accessible schools.\"\n },\n {\n \"call\": \"User Statistics\",\n \"call_path\": \"stats/users\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides basic user counts\"\n },\n {\n \"call\": \"User Statistics\",\n \"call_path\": \"stats/users\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides basic user counts\"\n },\n {\n \"call\": \"User Type Statistics\",\n \"call_path\": \"stats/userTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides basic user counts by user type\"\n },\n {\n \"call\": \"User Type Statistics\",\n \"call_path\": \"stats/userTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call provides basic user counts by user type\"\n },\n {\n \"call\": \"User Authentication\",\n \"call_path\": \"users/authenticate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call can be used to authenticate users\"\n },\n {\n \"call\": \"User Authentication\",\n \"call_path\": \"users/authenticate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"This call can be used to authenticate users\"\n },\n {\n \"call\": \"Calendar Sync\",\n \"call_path\": \"users/calendarSync\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Toggle ics calender export on.\"\n },\n {\n \"call\": \"Calendar Sync\",\n \"call_path\": \"users/calendarSync\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Toggle ics calender export on.\"\n },\n {\n \"call\": \"Search Course Coordinators\",\n \"call_path\": \"users/courseCoordinatorSearch\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Allows the client to search for course coordinators by name, employee ID, or username\"\n },\n {\n \"call\": \"Search Course Coordinators\",\n \"call_path\": \"users/courseCoordinatorSearch\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Allows the client to search for course coordinators by name, employee ID, or username\"\n },\n {\n \"call\": \"View Device Token\",\n \"call_path\": \"users/deviceToken\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Displays a users device UDID and token for a specified application\"\n },\n {\n \"call\": \"View Device Token\",\n \"call_path\": \"users/deviceToken\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Displays a users device UDID and token for a specified application\"\n },\n {\n \"call\": \"Active Faculty\",\n \"call_path\": \"users/faculty\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the active faculty in a specified program\"\n },\n {\n \"call\": \"Active Faculty\",\n \"call_path\": \"users/faculty\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the active faculty in a specified program\"\n },\n {\n \"call\": \"Add Faculty to Programs/Clerkships\",\n \"call_path\": \"users/facultyAccess\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Modifies the program/clerkship access of a faculty member.\"\n },\n {\n \"call\": \"Add Faculty to Programs/Clerkships\",\n \"call_path\": \"users/facultyAccess\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Modifies the program/clerkship access of a faculty member.\"\n },\n {\n \"call\": \"Create Faculty Member\",\n \"call_path\": \"users/facultyCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Creates a new faculty member.\"\n },\n {\n \"call\": \"Create Faculty Member\",\n \"call_path\": \"users/facultyCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Creates a new faculty member.\"\n },\n {\n \"call\": \"Faculty Demographic Fields List\",\n \"call_path\": \"users/facultyFields\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists faculty demographic fields.\"\n },\n {\n \"call\": \"Faculty Demographic Fields List\",\n \"call_path\": \"users/facultyFields\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists faculty demographic fields.\"\n },\n {\n \"call\": \"Faculty Demographics\",\n \"call_path\": \"users/facultyInfo\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Detailed demographic information for a faculty member\"\n },\n {\n \"call\": \"Faculty Demographics\",\n \"call_path\": \"users/facultyInfo\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Detailed demographic information for a faculty member\"\n },\n {\n \"call\": \"Search Faculty\",\n \"call_path\": \"users/facultySearch\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Allows the client to search for faculty by name, employee ID, or username\"\n },\n {\n \"call\": \"Search Faculty\",\n \"call_path\": \"users/facultySearch\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Allows the client to search for faculty by name, employee ID, or username\"\n },\n {\n \"call\": \"Update Faculty Demographics\",\n \"call_path\": \"users/facultyUpdate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Updates faculty demographic information.\"\n },\n {\n \"call\": \"Update Faculty Demographics\",\n \"call_path\": \"users/facultyUpdate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Updates faculty demographic information.\"\n },\n {\n \"call\": \"Off-Program Evaluators\",\n \"call_path\": \"users/off_program_evaluators\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists active off-program evaluators in a specified program\"\n },\n {\n \"call\": \"Off-Program Evaluators\",\n \"call_path\": \"users/off_program_evaluators\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists active off-program evaluators in a specified program\"\n },\n {\n \"call\": \"Off-Program Evaluators\",\n \"call_path\": \"users/off_program_evaluators\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists active off-program evaluators in a specified program\"\n },\n {\n \"call\": \"Off-Program Evaluators\",\n \"call_path\": \"users/off_program_evaluators\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists active off-program evaluators in a specified program\"\n },\n {\n \"call\": \"Outside Evaluators\",\n \"call_path\": \"users/outside\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists active outside evaluators in a specified program\"\n },\n {\n \"call\": \"Outside Evaluators\",\n \"call_path\": \"users/outside\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists active outside evaluators in a specified program\"\n },\n {\n \"call\": \"Outside Evaluator Lookup\",\n \"call_path\": \"users/outsideLookup\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Provides outside evaluator information given the unique identifier\"\n },\n {\n \"call\": \"Outside Evaluator Lookup\",\n \"call_path\": \"users/outsideLookup\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Provides outside evaluator information given the unique identifier\"\n },\n {\n \"call\": \"Missing Photos\",\n \"call_path\": \"users/photosMissing\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies active residents and faculty with missing photos\"\n },\n {\n \"call\": \"Missing Photos\",\n \"call_path\": \"users/photosMissing\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies active residents and faculty with missing photos\"\n },\n {\n \"call\": \"Create Resident\",\n \"call_path\": \"users/residentCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Creates a new resident.\"\n },\n {\n \"call\": \"Resident Demographic Fields List\",\n \"call_path\": \"users/residentFields\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists resident demographic fields.\"\n },\n {\n \"call\": \"Resident Demographics\",\n \"call_path\": \"users/residentInfo\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Detailed demographic information for a resident\"\n },\n {\n \"call\": \"Resident Demographics\",\n \"call_path\": \"users/residentInfo\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Detailed demographic information for a resident\"\n },\n {\n \"call\": \"Active Residents\",\n \"call_path\": \"users/residents\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the active residents in a specified program\"\n },\n {\n \"call\": \"Active Residents\",\n \"call_path\": \"users/residents\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists the active residents in a specified program\"\n },\n {\n \"call\": \"Active Residents Count\",\n \"call_path\": \"users/residentsCount\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a count of the active residents in a specified program\"\n },\n {\n \"call\": \"Active Residents Count\",\n \"call_path\": \"users/residentsCount\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a count of the active residents in a specified program\"\n },\n {\n \"call\": \"Active Residents Count\",\n \"call_path\": \"users/residentsCount\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a count of the active residents in a specified program\"\n },\n {\n \"call\": \"Active Residents Count\",\n \"call_path\": \"users/residentsCount\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a count of the active residents in a specified program\"\n },\n {\n \"call\": \"Active Residents Count\",\n \"call_path\": \"users/residentsCount\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Retrieves a count of the active residents in a specified program\"\n },\n {\n \"call\": \"Search Residents\",\n \"call_path\": \"users/residentSearch\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Allows the client to search for residents by name, employee ID, or username\"\n },\n {\n \"call\": \"Search Residents\",\n \"call_path\": \"users/residentSearch\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Allows the client to search for residents by name, employee ID, or username\"\n },\n {\n \"call\": \"Resident Training\",\n \"call_path\": \"users/residentTraining\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists full training history for a resident\"\n },\n {\n \"call\": \"Resident Training\",\n \"call_path\": \"users/residentTraining\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists full training history for a resident\"\n },\n {\n \"call\": \"Resident Types\",\n \"call_path\": \"users/residentTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard resident types\"\n },\n {\n \"call\": \"Resident Types\",\n \"call_path\": \"users/residentTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard resident types\"\n },\n {\n \"call\": \"Update Resident Demographics\",\n \"call_path\": \"users/residentUpdate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Updates resident demographic information.\"\n },\n {\n \"call\": \"Set Device Token\",\n \"call_path\": \"users/setDeviceToken\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Sets the users device UDID and token for an application\"\n },\n {\n \"call\": \"Set Device Token\",\n \"call_path\": \"users/setDeviceToken\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Sets the users device UDID and token for an application\"\n },\n {\n \"call\": \"Create Student\",\n \"call_path\": \"users/studentCreate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Creates a new student.\"\n },\n {\n \"call\": \"Student Demographic Fields List\",\n \"call_path\": \"users/studentFields\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists student demographic fields.\"\n },\n {\n \"call\": \"Student Demographics\",\n \"call_path\": \"users/studentInfo\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Detailed demographic information for a student\"\n },\n {\n \"call\": \"Active Students\",\n \"call_path\": \"users/students\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List of all courses\"\n },\n {\n \"call\": \"Search Students\",\n \"call_path\": \"users/studentSearch\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Allows search for students by name, employee ID, or username\"\n },\n {\n \"call\": \"Student Training\",\n \"call_path\": \"users/studentTraining\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Lists full training history for a student\"\n },\n {\n \"call\": \"Student Types\",\n \"call_path\": \"users/studentTypes\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"List of Student Types\"\n },\n {\n \"call\": \"Update Student Demographics\",\n \"call_path\": \"users/studentUpdate\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Updates student demographic information.\"\n },\n {\n \"call\": \"User Types\",\n \"call_path\": \"users/types\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard user types that can login to MedHub\"\n },\n {\n \"call\": \"User Types\",\n \"call_path\": \"users/types\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Identifies the standard user types that can login to MedHub\"\n },\n {\n \"call\": \"User Lookup\",\n \"call_path\": \"users/userLookup\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Provides user information given the unique identifier\"\n },\n {\n \"call\": \"User Lookup\",\n \"call_path\": \"users/userLookup\",\n \"status\": \"Active\",\n \"request_type\": \"POST\",\n \"call_description\": \"Provides user information given the unique identifier\"\n }\n]"}],"_postman_id":"49e70180-b771-46eb-8e3c-aab39e0919a9"}],"id":"443a81a1-70a9-44bf-848f-e3af0234bbf5","_postman_id":"443a81a1-70a9-44bf-848f-e3af0234bbf5","description":""},{"name":"Conferences","item":[{"name":"conferences/attendance","id":"8a12a14d-90e8-4c05-ac4e-2745e6584a8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"{\"userID\":97927, \"programID\":481, \"startDate\":\"2018-07-01\",\"endDate\":\"2019-06-30\"}","description":"example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/conferences/attendance","description":"Lists the conferences attended by an individual user over a specified date range.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.01 | \nn/a | \n
| programID | \ninteger | \nYes* | \nv0.90 | \nRequired if courseID not specified | \n
| courseID | \ninteger | \nYes* | \nv1.06 | \nRequired if programID not specified | \n
| startDate | \ndate | \nNo | \nv1.01 | \nformat YYYY-MM-DD | \n
| endDate | \ndate | \nNo | \nv1.01 | \nformat YYYY-MM-DD | \n
example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/conferences/groups","description":"Lists the conference groups defined for a given program or course.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes* | \nv0.90 | \nRequired if courseID not specified | \n
| courseID | \ninteger | \nYes* | \nv1.06 | \nRequired if programID not specified | \n
example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/conferences/record","description":"Records attendance for a specified conference.
\nNote: the input variables listed below must be sent as a multi-dimensional array, with each record providing the following values and a parent index of ‘attendance’.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| attendance | \narray | \n\n | \n | Parent index that holds attendance records | \n
| conferenceID | \ninteger | \nYes | \nv1.01 | \nUse conferences/schedule to get a list of conferenceIDs | \n
| userID | \ninteger | \nYes | \nv1.01 | \nUnique user identifier | \n
| late_flag | \ninteger | \nNo | \nv1.01 | \nIf not provided (or if set to \"0\") the user was not late | \n
example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/conferences/schedule","description":"Lists the conference schedule for a program over a specified date range.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes* | \nv0.90 | \nRequired if courseID not specified | \n
| courseID | \ninteger | \nYes* | \nv1.06 | \nRequired if programID not specified | \n
| startDate | \ndate | \nYes | \nv1.01 | \n\n |
| endDate | \ndate | \nYes | \nv1.01 | \n\n |
| groupID | \ninteger | \nNo | \nv1.01 | \nUse to filter schedule by conference group | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| conferenceID | \nUnique conference identifier | \ntext | \nv1.01 | \n\n |
| date | \nconference date | \ndate | \nv1.01 | \nformat YYYY-MM-DD | \n
| start_time | \nconference start time | \ntime | \nv1.01 | \nformat HH:MM:SS | \n
| end_time | \nconference end time | \ntime | \nv1.01 | \nformat HH:MM:SS | \n
| title | \nconference title | \ntext | \nv1.01 | \n\n |
| location | \nconference location | \ntext | \nv1.01 | \n\n |
| groupID | \nunique conference group identifier | \ninteger | \nv1.01 | \nuse conferences/groups to get groupIDs | \n
| attendance_flag | \nflag if attendance is taken | \ninteger | \nv1.01 | \n\"0\" = no attendance, \"1\" = attendance taken | \n
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/courses/all","description":"Lists all active courses within the institution, regardless of API client access.
\n| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
courseID | unique course identifier | integer | v1.06 | |
course_name | course name | string | v1.06 | |
course_abbrev | course abbreviation | string | v1.06 |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/courses/access","description":"Lists all courses accessible by this API client as granted by the UME Office Student Administrator(s).
\n| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \nunique course identifier | \ninteger | \nv1.06 | \n\n |
| course_name | \ncourse name | \nstring | \nv1.06 | \n\n |
| course_abbrev | \ncourse abbreviation | \nstring | \nv1.06 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"school_id\":1,\"course_name\":\"Example New Course\",\"course_abbrv\":\"ExampleNC\",\"course_number\":\"13579\",\"location_id\":\"4\",\"group_id\":\"\",\"course_parent\":\"\",\"director_id\":\"77116\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/courses/courseCreate","description":"Creates a new course in MedHub
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| school_id | integer | Yes | v1.22 | |
| course_name | string | Yes | v1.22 | max 100 characters |
| course_abbrv | string | Yes | v1.22 | max 20 characters |
| course_number | string | Yes | v1.22 | |
| location_id | integer | Yes | v1.22 | use courses/locations to get a list of available location_ids |
| group_id | integer | No | v1.22 | use courses/groups to get a list of available group_ids |
| course_parent | integer | No | v1.22 | use courses/parents to get a list of available course_parent IDs |
| director_id | integer | No | v1.22 | sets a faculty userID as the course director |
| administrator_id | integer | No | v1.22 | sets a coordinator userID as the primary course coordinator |
| block_id | integer | No | v1.22 | |
| credit_hours | float | No | v1.22 |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| courseID | unique course identifier | integer | v1.22 |
example only
\n","key":"request","type":"text","value":"{\"courseID\":837, \"course_name\":\"New Name\",\"course_abbrv\":NEW}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/courses/update","description":"Updates a course/clerkship's information
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| courseID | integer | Yes | v1.27 | |
| course_name | string | No | v1.27 | max 100 characters |
| course_abbrv | string | No | v1.27 | max 15 characters |
| course_number | string | No | v1.27 | |
| course_status | No | v1.27 | ||
| location_id | integer | No | v1.27 | use courses/locations to get a list of available location_ids |
| group_id | integer | No | v1.27 | use courses/groups to get a list of available group_ids |
| course_parent | integer | No | v1.27 | use courses/parents to get a list of available course_parent IDs |
| director_id | integer | No | v1.27 | change/add a faculty userID as the course director |
| administrator_id | integer | No | v1.27 | change/add a coordinator userID as the primary course coordinator |
| block_id | integer | No | v1.27 | |
| credit_hours | float | No | v1.27 |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/courses/parents","description":"Retrieves a list of all course parents.
\n| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| id | \nunique course parent identifier | \ninteger | \nv1.28 | \n\n |
| name | \ncourse parent name | \nstring | \nv1.28 | \n\n |
| abbreviation | \ncourse parent abbreviation | \nstring | \nv1.28 | \n\n |
| departmentID | \nunique department identifer | \ninteger | \nv1.28 | \n\n |
| schoolID | \nunique school identifer | \ninteger | \nv1.28 | \n\n |
| active | \nshows whether or not the course parent is active | \nboolean | \nv1.28 | \n\n |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/courses/locations","description":"Retrieves a list of all active course locations
\n| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| id | \nunique location identifier | \ninteger | \nv1.28 | \n\n |
| name | \ncourse location name | \nstring | \nv1.28 | \n\n |
| active | \nshows whether or not the location is active | \nboolean | \nv1.28 | \n\n |
| class_section | \n\n | string | \nv1.28 | \n\n |
| schoolID | \nunique school identifier | \ninteger | \nv1.28 | \n\n |
| address | \nlocation address | \nstring | \nv1.28 | \n\n |
| geocode | \n\n | \n | v1.28 | \n\n |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/courses/groups","description":"Retrieves a list of all course groups and their IDs.
\n| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| clerkship_groupID | \nunique group identifier | \ninteger | \nv1.28 | \n\n |
| group_name | \ncourse group name | \nstring | \nv1.28 | \n\n |
| group_abbrev | \ncourse group abbreviation | \nstring | \nv1.28 | \n\n |
| group_required | \n\n | integer | \nv1.28 | \n\"0\" = not required, \"1\" = required | \n
| standard_yearA | \n\n | \n | v1.28 | \n\n |
| status | \nshows the current status of the course group | \ninteger | \nv1.28 | \n\n |
Retrieves a list of curriculum objectives/goals for a given globalserviceID, clinicnameID, courseID, or programID.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \ninteger | \nNo* | \n\n | *Required if no other parameter is given. | \n
| programID | \ninteger | \nNo* | \n\n | *Required if no other parameter is given. | \n
| globalserviceID | \ninteger | \nNo* | \n\n | *Required if no other parameter is given. | \n
| clinicnameID | \ninteger | \nNo* | \n\n | *Required if no other parameter is given. | \n
example only
\n","key":"request","type":"text","value":"{\"courseID\":1066, \"rotationsetID\":19}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/curriculummap/course","description":"Provides course data for a specified course, including linked sessions and course objectives.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \ninteger | \nYes | \n\n | \n |
| rotationsetID | \ninteger | \nYes | \n\n | identifies the academic year | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \nunique course identifier | \ninteger | \n\n | \n |
| courseName | \ncourse name | \nstring | \n\n | \n |
| courseAbbreviation | \ncourse Abbreviation | \nstring | \n\n | \n |
| sessionIDs | \nunique identifiers of course sessions | \narray | \n\n | \n |
| courseObjectiveIDs | \nunique identifiers of course objectives | \narray | \n\n | \n |
example only
\n","key":"request","type":"text","value":"{\"courseObjectiveID\":149980}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/curriculummap/courseObjective","description":"Provides sessions, session objectives, and EPOs linked to the specified course objective ID.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseObjectiveID | \ninteger | \nYes | \n\n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseObjectiveID | \nunique identifier for course objective | \ninteger | \n\n | \n |
| courseObjectiveName | \ncourse objective name | \nstring | \n\n | \n |
| epoIDs | \nunique identifiers for linked EPOs | \narray | \n\n | list of all Educational Program Objectives IDs to which the specified course objective is linked | \n
| sessionIDs | \nunique identifiers for linked sessions | \narray | \n\n | list of all session IDs linked to the specified course objective | \n
| sessionObjectiveIDs | \nunique identifiers for linked session objectives | \narray | \n\n | list of all session objective IDs linked to the specified course objective | \n
example only
\n","key":"request","type":"text","value":"{\"sessionID\":26571}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/curriculummap/session","description":"Provides session data for a specified session ID, including linked session and course objectives.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| sessionID | \ninteger | \nYes | \n\n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| sessionID | \nunique session identifier | \ninteger | \n\n | \n |
| sessionName | \nsession name | \nstring | \n\n | \n |
| duration | \nduration of session | \nstring | \n\n | Format in HH:MM | \n
| intensive | \n\n | string | \n\n | \"Yes\" or \"No\" | \n
| sessionObjectiveIDs | \nlist of unique identifiers for linked session objectives | \narray | \n\n | \n |
| courseObjectiveIDs | \nlist of unique identifiers for linked course objectives | \narray | \n\n | \n |
example only
\n","key":"request","type":"text","value":"{\"sessionObjectiveID\":149981}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/curriculummap/sessionObjective","description":"Provides sessions, course objectives, and EPOs linked to the specified session objective.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| sessionObjectiveID | \ninteger | \nYes | \n\n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| sessionObjectiveID | \nunique session objective identifier | \ninteger | \n\n | \n |
| sessionObjectiveName | \nsession objective name | \nstring | \n\n | \n |
| epoIDs | \nlist of unique identifiers for linked Educational Program Objectives | \narray | \n\n | \n |
| courseSessionIDs | \nlist of unique identifiers for linked course sessions | \narray | \n\n | includes all session IDs for all sessions linked to the specified session objective | \n
| courseObjectiveIDs | \nunique identifiers for linked course objectives | \narray | \n\n | includes IDs for all course objectives linked to the specified session objective | \n
example only
\n","key":"request","type":"text","value":"{\"userID\":97927,\"startTime\":\"2020-06-01 08:00:00\",\"endTime\":\"2020-06-01 16:30:00\",\"periodType\":0}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/post","description":"This call can be used to post a duty hour work period for a resident or student.
\nNote, provided start/end times will be rounded to closest half hour, which is the lowest level of time precision currently maintained by MedHub.
\nDuty hours can only be posted during the standard 2-week entry period, which includes the previous calendar week (starting Sunday) through the current\nSaturday at midnight.
\nThis call will add hours, but each resident will still be required to review these hours in MedHub and submit as completed.
| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.03 | \n\n |
| startTime | \ndatetime | \nYes | \nv1.03 | \nFormat YYYY-MM-DD HH:MM:SS Must be during an unlocked date period (this generally includes the last and current calendar week). | \n
| endTime | \ndatetime | \nYes | \nv1.03 | \nFormat YYYY-MM-DD HH:MM:SS Must occur after the startTime value but within one day. | \n
| periodType | \ninteger | \nYes | \nv1.03 | \nValues:
| \n
example only
\n","key":"request","type":"text","value":"{\"userID\":97927,\"date\":\"2020-06-01\",\"startTime\":\"08:00:00\",\"endTime\":\"16:30:00\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/delete","description":"This call can be used to delete an entry on a resident or student timesheet.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.05 | \n\n |
| date | \ndate | \nYes | \nv1.05 | \nFormat YYYY-MM-DD | \n
| startTime | \ntime | \nYes | \nv1.05 | \nFormat HH:MM:SS | \n
| endTime | \ntime | \nYes | \nv1.05 | \nFormat HH:MM:SS | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| result | \nstatus of deletion | \ninteger | \nv1.05 | \nValues: 0 = failed, 1 = success | \n
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/reasons","description":"Retrieves a list of all potential reasons for timesheet violations.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| n/a | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| reasonID | \nunique identifier of violation reason | \ninteger | \nv0.90 | \n\n |
| reason_name | \nname of violation reason | \ntext | \nv0.90 | \n\n |
no input required
\n","key":"request","type":"text","value":"{\"programID\":481,\"startDate\":\"2020-05-01\",\"endDate\":\"2020-05-31\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/reviews","description":"Retrieves Director Duty Hour Review Periods for a given a program.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes | \nv0.90 | \n\n |
| startDate | \ndate | \nYes | \nv0.90 | \nFormat YYYY-MM-DD | \n
| endDate | \ndate | \nYes | \nv0.90 | \nFormat YYYY-MM-DD | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| scheduleID | \nunique identifier of schedule defined for given time period | \ninteger | \nv0.90 | \n\n |
| schedule_name | \nname of schedule defined for given time period | \ntext | \nv0.90 | \n\n |
| start_date | \nstart date of review period | \ndate | \nv0.90 | \nFormat YYYY-MM-DD | \n
| end_date | \nend date of review period | \ndate | \nv0.90 | \nFormat YYYY-MM-DD | \n
| violations | \nnumber of violations in review period | \ninteger | \nv0.90 | \n\n |
| status | \nstatus of review period | \ntext | \nv0.90 | \nComplete/Incomplete | \n
| school_name | \nName of school | \ntext | \nv0.90 | \nOnly applicable if the institution's medical school uses MedHub | \n
example only
\n","key":"request","type":"text","value":"{\"userID\":97927}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/status","description":"Retrieves available timesheets for a given user.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.05 | \n\n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| startDate | \ndate the timesheet begins (start of week) | \ndate | \nv1.05 | \nFormat YYYY-MM-DD | \n
| endDate | \ndate the timesheet ends (end of week) | \ndate | \nv1.05 | \nFormat YYYY-MM-DD | \n
| dueDate | \ndate when the timesheet is due | \ndate | \nv1.05 | \nFormat YYYY-MM-DD | \n
| status | \ncurrent status of timesheet | \nstring | \nv1.05 | \nValues: incomplete, complete, complete_nc, na | \n
| hours | \ntotal number of hours logged in timesheet | \nfloat | \nv1.05 | \n\n |
| submitRequired | \ntells whether or not timesheet submission is required | \nboolean | \nv1.05 | \nTRUE if timesheet submission is required | \n
| hash | \nchecksum of changes to status and recorded hours | \nstring | \nv1.05 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"userID\":97927,\"date\":\"2020-06-06\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/submit","description":"Submits a weekly timesheet for a given resident or student.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.05 | \n\n |
| date | \ndate | \nYes | \nv1.05 | \nFormat YYYY-MM-DD | \n
| exceptions | \narray | \nYes* | \nv1.05 | \n*Only required if potential break violation exceptions exist | \n
| violationReasonID | \ninteger | \nYes* | \nv1.05 | \n*Only required if potential violations are discovered on timesheet | \n
| violationNotes | \nstring | \nYes* | \nv1.05 | \n*Only required if potential violations are discovered on timesheet | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| response | \ndescription of response | \ntext | \nv1.05 | \nValues:
| \n
| pendingList | \nlist of potential break violation gaps to be addressed as violations or exceptions | \narray | \nv1.05 | \nReturned only for response status \"pending-break-exception\". Each item in list contains the following \"key\" : \"value\" pairs:
| \n
| exceptionTypes | \nlist of violation or exception types | \narray | \nv1.05 | \nReturned only for response status \"pending-break-exception\".\n |
| violationList | \nlist of potential violations discovered on timesheet | \narray | \nv1.05 | \nReturned only for response status \"pending-violation-reason\".\n |
| violationReasonList | \nlist of available violationReasonIDs with labels | \narray | \nv1.05 | \nReturned only for response status \"pending-violation-reason\".\n |
| violationReasonID | \ncurrently recorded violation reason | \ninteger | \nv1.05 | \nReturned only for response status \"pending-violation-reason\".\n |
| violationNotes | \ncurrently recorded violation notes | \nstring | \nv1.05 | \nReturned only for response status \"pending-violation-reason\".\n |
example only
\n","key":"request","type":"text","value":"{\"userID\":97927, \"startDate\":\"2020-05-15\",\"endDate\":\"2020-06-01\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/timesheets","description":"Retrieves timesheet data for a given resident over a specified date period.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv0.90 | \n\n |
| startDate | \ndate | \nYes | \nv0.90 | \nFormat YYYY-MM-DD | \n
| endDate | \ndate | \nYes | \nv0.90 | \nFormat YYYY-MM-DD | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| date | \ndate on timesheet | \ndate | \nv0.90 | \nFormat YYYY-MM-DD | \n
| start_time | \nstart time logged for date on timesheet | \ntime | \nv0.90 | \nFormat HH:MM:SS | \n
| end_time | \nend time logged for date on timesheet | \ntime | \nv0.90 | \nFormat HH:MM:SS | \n
| worktypeID | \nunique identifier of work type selected for logged hours | \ninteger | \nv0.90 | \nUse dutyhours/workTypes to get a list of all available work types | \n
| absence_type | \ntype of absence logged | \ninteger | \nv0.90 | \nValues:
| \n
| status | \nstatus of timesheet | \nstring | \nv0.90 | \nValues: Incomplete/Submitted | \n
example only
\n","key":"request","type":"text","value":"{\"userID\":97927, \"date\":\"2020-06-03\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/week","description":"Retrieves weekly details of a resident or student timesheet.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.05 | \n\n |
| date | \ndate | \nYes | \nv1.05 | \nFormat YYYY-MM-DD Note, response will include the entire week encompassing the given date | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| access | \naccess to work hours | \nboolean | \nv1.05 | \nTRUE if user has access to work hours; if FALSE, no other fields will be returned | \n
| hash | \nchecksum of changes to status and recorded hours | \nstring | \nv1.05 | \n\n |
| startDate | \nstart of week | \ndate | \nv1.05 | \nFormat YYYY-MM-DD | \n
| endDate | \nend of week | \ndate | \nv1.05 | \nFormat YYYY-MM-DD | \n
| dueDate | \ndate when timesheet is due | \ndate | \nv1.05 | \nFormat YYYY-MM-DD | \n
| status | \ncurrent status of timesheet | \nstring | \nv1.05 | \nValues: \"incomplete\", \"complete\", \"complete_nc\", \"na\" | \n
| hours | \ntotal hours logged for the week | \nfloat | \nv1.05 | \n\n |
| submitRequired | \nshows whether or not submission of timesheet is required | \nboolean | \nv1.05 | \nTRUE if timesheet submission is required | \n
| violationReasonID | \nunique identifier for violation reason | \ninteger | \nv1.05 | \nIncluded only when violation reason is recorded | \n
| violationReason | \ndesciption of violation reason | \nstring | \nv1.05 | \nIncluded only when violation reason is recorded | \n
| violationNotes | \nnotes that were provided in response to logged violation | \nstring | \nv1.05 | \nIncluded only when violation reason is recorded | \n
| complianceChecklist | \nlist of violation rules and statuses | \narray | \nv1.05 | \nEach item in list contains key-value pair \"label\" (string) : \"compliant\" (boolean) | \n
| days | \nlist of days and recorded activities | \narray | \nv1.05 | \nEach item in list contains the following key-value pairs:\n
|
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/dutyhours/workTypes","description":"Retrieves all work type options for a work hour entry.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| n/a | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| worktypeID | \nunique identifier of work type | \ninteger | \nv0.90 | \n\n |
| worktype_name | \nname of work type | \nstring | \nv0.90 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"enrollmentID\":26359, \"official_grade_scale_option_value\":\"Pass\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollments/gradeCreate","description":"Create a new grade record for a student.
\nNote: the result of this call will be a new grade record. If there exists a previous grade record for the enrollment, those grades will be pulled into the new record except where this call would update/overwrite them. This call does not allow for the deletion of grade records. Use enrollments/gradeOptions call to get a list of all acceptable grade inputs for a given enrollment ID.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| enrollmentID | \ninteger | \nYes | \n\n | unique identifier for the enrollment record | \n
| schoolID | \ninteger | \nNo | \n\n | required if referencing an enrollment for a school other than the primary (defaults to 1) | \n
| offical_grade_scale_option_value | \nstring | \nNo (at least one required) | \n\n | at least one of the following is required: offical_grade_scale_option_value, numeric_grade, or component_grades | \n
| numeric_grade | \ninteger | float | \nNo (at least one required) | \n\n | at least one of the following is required: offical_grade_scale_option_value, numeric_grade, or component_grades | \n
| component_grades | \narray | \nNo (at least one required) | \n\n | array of objects that contain an 'id': int, 'score': int|float. At least one of the following is required: offical_grade_scale_option_value, numeric_grade, or component_grades | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| response | \n\"success\" if grade was successfully posted | \nstring | \n\n | \n |
| gradeID | \nunique identifier of persisted grade record | \ninteger | \n\n | \n |
example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollments/enrollmentDrop","description":"Drop a student’s enrollment in a course/clerkship in MedHub
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| enrollmentID | \ninteger | \nYes | \n\n | use schedules/enrollment to get enrollmentIDs | \n
example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollments/enrollmentCreate","description":"Create a new enrollment record for a student
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.22 | \n\n |
| courseID | \ninteger | \nYes | \nv1.22 | \n\n |
| periodID | \ninteger | \nNo* | \nv1.22 | \n*required if start_date and end_date are not provided; use enrollmentperiods/periodCreate to create new enrollment periods | \n
| start_date | \ndate | \nNo* | \nv1.22 | \n*required if periodID is not provided; these dates must match an existing date period for the given course; format YYYY-MM-DD; if request is invalid, try entering as \"startDate\" | \n
| end_date | \ndate | \nNo* | \nv1.22 | \n*required if periodID is not provided; these dates must match an existing date period for the given course; format YYYY-MM-DD; if request is invalid, try entering as \"endDate\" | \n
| status | \ninteger | \nYes | \nv1.22 | \nenrolled = \"1\", waitlist = \"3\", note: you cannot create a record with a \"dropped\" status; use enrollments/enrollmentDrop | \n
| credit_hours | \nfloat | \nNo | \nv1.22 | \n\n |
example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollments/gradeOptions","description":"Get the possible grading options for a given enrollment id
\n","urlObject":{"path":["enrollments","gradeOptions"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"7cb67a59-ca35-4c99-85f1-3d5d4f3213eb","name":"enrollments/gradeOptions","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"{\"enrollmentID\":26359}","description":"example only","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollments/gradeOptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 May 2020 13:11:16 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"components\": null,\n \"grade_scale_type\": {\n \"scale_value\": 0,\n \"scale_name\": \"Scale Options\"\n },\n \"grade_scale_options\": [\n {\n \"option_name\": \"Fail\",\n \"option_value\": \"Fail\"\n },\n {\n \"option_name\": \"Pass\",\n \"option_value\": \"Pass\"\n },\n {\n \"option_name\": \"Incomplete\",\n \"option_value\": \"INCMP\"\n },\n {\n \"option_name\": \"Withdraw\",\n \"option_value\": \"W\"\n }\n ],\n \"official_grade_scale_option_value\": null,\n \"numeric_grade\": 1,\n \"component_grades\": [\n {\n \"id\": 1,\n \"name\": \"Clinical Performance\",\n \"score\": \"\"\n },\n {\n \"id\": 7,\n \"name\": \"Mid-Rotation Exam\",\n \"score\": \"1\"\n },\n {\n \"id\": 34,\n \"name\": \"Write up\",\n \"score\": \"-1\"\n }\n ],\n \"grade_submitted_date\": \"2020-05-05 09:11:15\"\n}"}],"_postman_id":"8e573081-b5b6-4d9f-b5f9-ef7c3d2c7b44"}],"id":"e125990d-88a4-47c3-a22c-a12d6366a3cb","description":"Calls relating to UME enrollments
\n","_postman_id":"e125990d-88a4-47c3-a22c-a12d6366a3cb"},{"name":"Enrollment Periods","item":[{"name":"enrollmentperiods/periodCreate","id":"0e9badcf-f044-49ee-94c1-1fdebfee5070","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only
\n","key":"request","type":"text","value":"{\"courseID\":756,\"startDate\":\"2020-08-01\",\"endDate\":\"2020-08-30\",\"students_min\":1,\"students_max\":10}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollmentperiods/periodCreate","description":"Create a new enrollment period
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \ninteger | \nYes | \n\n | unique identifier for a course | \n
| startDate | \ndate | \nYes | \n\n | start date of period, must match an existing period; format YYYY-MM-DD | \n
| endDate | \ndate | \nYes | \n\n | end date of period, must match an existing period; format YYYY-MM-DD | \n
| students_min | \ninteger | \nNo | \n\n | minimum capacity of course | \n
| students_max | \ninteger | \nNo | \n\n | maximum capacity of course | \n
| otherID | \ninteger | \nNo | \n\n | idenifier for external use | \n
example only
\n","key":"request","type":"text","value":"{\"courseID\":756,\"startDate\":\"2020-08-01\",\"endDate\":\"2020-08-30\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollmentperiods/periodDelete","description":"Delete an existing enrollment period
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \ninteger | \nYes | \n\n | unique identifier for a course | \n
| startDate | \ndate | \nYes | \n\n | start date of period, must match an existing period; format YYYY-MM-DD | \n
| endDate | \ndate | \nYes | \n\n | end date of period, must match an existing period; format YYYY-MM-DD | \n
example only
\n","key":"request","type":"text","value":"{\"courseID\":756,\"startDate\":\"2020-07-01\",\"endDate\":\"2020-09-01\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollmentperiods/periods","description":"List all existing open enrollment periods for a course and date range
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| courseID | integer | Yes | unique identifier for a course | |
| startDate | date | Yes | start date of period; format YYYY-MM-DD | |
| endDate | date | Yes | end date of period; format YYYY-MM-DD |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| startDate | start date of period | date | format YYYY-MM-DD | |
| endDate | end date of period | date | format YYYY-MM-DD | |
| students_min | minimum capacity of course | integer | ||
| students_max | maximum capacity of course | integer | ||
| enrolled | number of enrolled students | integer | ||
| otherID | idenifier for external use | integer |
example only
\n","key":"request","type":"text","value":"{\"courseID\":756,\"startDate\":\"2020-08-01\",\"endDate\":\"2020-08-31\",\"students_min\":2,\"otherID\":\"12345\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/enrollmentperiods/periodUpdate","description":"Update an existing enrollment period
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \ninteger | \nYes | \n\n | unique identifier for a course | \n
| startDate | \ndate | \nYes | \n\n | start date of period, must match an existing period; format YYYY-MM-DD | \n
| endDate | \ndate | \nYes | \n\n | end date of period, must match an existing period; format YYYY-MM-DD | \n
| students_min | \ninteger | \nNo | \n\n | minimum capacity of course | \n
| students_max | \ninteger | \nNo | \n\n | maximum capacity of course | \n
| otherID | \ninteger | \nNo | \n\n | idenifier for external use | \n
example only
\n","key":"request","type":"text","value":"{\"startDate\":\"2020-02-01\",\"endDate\":\"2020-06-01\",\"programs\":[481,890],\"types\":[2,5]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/responses","description":"Retrieves completed evaluation data filtered by given parameters.
\nNote: this call is often subject to error “E05”, which identifies a request that was too large.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
startDate | date | Yes | v1.02 | First completion date to include in response. Format must be \"YYYY-MM-DD\". |
endDate | date | No | v1.02 | Last completion date to include in response. Defaults to today's date if not provided. Format must be \"YYYY-MM-DD\". |
issued_startDate | date | No | v1.02 | First issued date to include in response. If not provided, response will not be limited by issue date. Format must be \"YYYY-MM-DD\". |
issued_endDate | date | No | v1.02 | Last issued date to include in response. If not provided, response will not be limited by issue date. Format must be \"YYYY-MM-DD\". |
types | array | No | v1.02 | Array of ID integers identifying which evaluation types to include in response. Use evals/types to get a list of all available evaluation types. If not provided, defaults to all types. |
programs | array | No | v1.02 | Array of programID integers identifying the program(s) that delivered the evaluation. Use programs/all to get a list of all available programs. If not provided, defaults to all programs for which the API client has access. |
courses | array | No | v1.06 | Array of courseID integers identifying the course(es) that delivered the evaluation. Use courses/all to get a list of all available courses. If not provided, defaults to all courses for which the API client has access. |
evaluators | array | No | v1.02 | Array of integers and strings identifying the evaluators to include in the response. If a value starts with a 'o', the following number will identify an outside evaluator. |
evaluatees | array | No | v1.02 | Array of integers and strings identifying the target users to include in the response. If a value starts with a 'o', the following number will identify an outside evaluator. |
forms | array | No | v1.02 | Array of evaluationID integers identifying the evaluation forms to include in the response. Use evals/forms to get a list of active evaluations for a given program or course. If not provided, defaults to all forms. |
globalservices | array | No | v1.02 | Array of globalserviceID integers identifying the service groups to include in the response. Use schedules/services to get a list of all service groups for a given program. If not provided this filter will not be applied. |
clinicnames | array | No | v1.02 | Array of clinicnameID integers identifying the clinics to include in the response. Use schedules/clinics to get a list of all clinics for a given program or course. |
responses | array | No | v1.07 | Array of responseID integers identifying one or more specific evaluaton responses (i.e. completed evaluations) to include in the results. |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
responseID | unique identifier for evaluation response (i.e. a completed evaluation) | integer | v1.01 | |
evaluationID | unique identifier for evaluatuion form | integer | v1.01 | Use evals/forms to get a list of active evaluation forms and high level form data for a given program or course. |
eval_type | unique identifier for evaluation type | integer | v1.01 | Use evals/types to get a list of all evaluation type identifiers and names. |
evaluator_userID | unique identifier for in-house evaluator (i.e. userID of in-house evaluator) | integer | v1.01 | Use users/userLookup to get additional information about a user. A zero (\"0\") is returned if not applicable. |
evaluator_outsideID | unique identifer for outside evaluator | integer | v1.01 | Use users/outsideLookup to get more information about a given outside evaluator (outsideID). A zero (\"0\") is returned if not applicable. |
evaluator_name | full name of evaluator | string | v1.08 | |
evaluatee_userID | unique identifier of in-house target user (i.e. userID of evaluation target) | integer | v1.01 | Use user/userLookup for additional information about target user. A zero (\"0\") is returned if not applicable. |
evaluatee_outsideID | unique identifier for outside target (i.e. ID of outside evaluator account that is the target of the evaluation) | integer | v1.01 | Use users/outsideLookup to get more information about a given outside evaluator (outsideID). A zero (\"0\") is returned if not applicable. |
evaluatee_name | full name of evaluatee | string | v1.08 | |
response_title | full title of response | string | v1.01 | |
eval_title | title of evaluation form | string | v1.08 | |
response_notes | delivery notes | string | v1.01 | Notes are added at time of delivery |
issue_date | date the evaluation was issued | date | v1.01 | |
completion_date | date the evaluation was completed | date | v1.01 | |
programID | unique identifier for the program that delivered the evaluation | integer | v1.01 | Use programs/all to get a list of all programs. |
courseID | unique identifier for the course that delivered the evaluation | integer | v1.06 | Use courses/all to get a list of all courses |
globalserviceID | unique identifier for service group | integer | v1.01 | Use schedules/services to get a list of all service groups for a given program or course. A zero (\"0\") is returned if not applicable. |
globalservice_name | full name of service group | string | v1.16 | |
clinicnameID | unique identifier of clinic | integer | v1.01 | Use schedules/clinics for additional information. A zero (\"0\") is returned if not applicable. |
clinicname | full name of clinic | string | v1.16 | |
conferenceID | unique identifier for a conference | integer | v1.01 | Use conferences/schedule for additional information. A zero (\"0\") is returned if not applicable. |
procedureID | unique identifier for a procedure log | integer | v1.01 | Use procedures/logs to get additional information in a list of procedures logged by a given user. A zero (\"0\") is returned if not applicable |
rotation_start_date | start date of the rotation for which the evaluation was delivered | date | v1.01 | |
rotation_end_date | end date of the rotation for which the evaluation was delivered | date | v1.01 | |
delivery_option | chosen special delivery option | integer | v1.01 | Values: 0 = none, 1 = signature required, 2 = anonymous |
program_notes | review notes provided by program | string | v1.01 | |
alert_flag | low score alert flag | integer | v1.01 | Values: 0 = no alert, 1 = alert |
answers | array of answers given in the evaluation response | array | v1.01 | The following key-value pairs will be included:
|
eh_responses.flag_released | Used to indicate when an evaluation response has been released. |
example only
\n","key":"request","type":"text","value":"{\"evaluationID\":1049,\"headers\":\"TRUE\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/questions","description":"Retrieves the evaluation questions and question options for a given evaluation form.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
evaluationID | integer | Yes | v1.00 | Use evals/forms to get a list of all evaluation forms available to a given program. |
headers | boolean | No | v1.11 | Tell wether or not to include question header data in results. Default = FALSE. |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
type | item type | string | v1.11 | Values: \"question\" or \"header\" |
header_text | header text | string | v1.13 | Only set for \"header\" item type |
header_intro | the introductory text of a header | string | v1.13 | Only set for \"header\" item type |
questionID | unique identifier for a question | integer | v1.00 | |
question_order | identifies the order of the question on the evaluation form | integer | v1.00 | |
question_number | question number | integer | v1.00 | Optionally defined by user |
question_text | question text | string | v1.00 | |
question_required | flag for if question is required to be completed | integer | v1.00 | Values: 1 = required, 0 = optional |
question_type | type of question | string | v1.00 | Values: Scale, Pull-down Menu, Checkboxes, Short Text, Long Text, Comment |
optionsetID | unique identifier for a scale | integer | v1.00 | |
optionset_title | title of scale | string | v1.00 | |
options | array of options in specified scale | array | v1.00 | Options are defined for questions of types: Scale, Pull-down Menu, Checkboxes. Each option will include the following key-value pairs:
|
headers | array of header text that is dispalyed above options for scale-based questions | array | v1.03 | Used for scales only, and will not be included if headers are not used. If headers are used, will return the following key-value pairs:
|
skip_enabled | whether or not skip logic is enabled | string | v1.19 | If enabled, values include: \"hidden\" or \"visible\" (referring to wether or not the question starts out hidden or visible). |
skip_parent | questionID for the parent question of a skip logic configuration | integer | v1.19 | Refers to the question whose answer(s) are the trigger to show/hide this question. |
skip_parent_options | answer options that act as the show/hide trigger | array | v1.19 | This is a zero indexed array of optionIDs on the parent question whose answer will trigger the show/hide logic on the enabled question. |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/forms","description":"Retrieves a list of active evaluation forms for a given program or course.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes* | \nv0.90 | \nRequired if courseID not given | \n
| courseID | \ninteger | \nYes* | \nv1.06 | \nRequired if programID not given | \n
| evaluations | \narray | \nNo | \nv1.07 | \nOptional array of evaluationIDs to limit results to specific forms | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| evaluationID | \nunique identifier for an evaluation form | \ninteger | \nv0.90 | \n\n |
| evaluation_title | \ntitle of an evaluation form | \nstring | \nv0.90 | \n\n |
| introduction | \nintroduction to an evaluation form | \nstring | \nv0.90 | \n\n |
| questions_count | \nnumber of questions on an evaluation form | \ninteger | \nv0.90 | \n\n |
| types | \nevaluation types linked to an evaluation form | \narray | \nv0.90 | \nThe array will contain integers that identify each evaluation type | \n
example only
\n","key":"request","type":"text","value":"{\"evaluationID\":4083,\"eval_type\":4,\"evaluator_userID\":119711,\"programID\":441,\"notify\":\"TRUE\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/initiate","description":"Delivers a new evaluation.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| evaluationID | integer | Yes | v1.15 | Use evals/forms to get a list of all active evaluations for a given program or course. |
| eval_type | integer | Yes | v1.15 | Use evals/types to get a list of all available evaluation types. |
| evaluator_userID | integer | Yes | v1.15 | Identifies the user that will recieve the evaluation. |
| programID | integer | Yes\\* | v1.15 | Identifies the program delivering the evaluation. \\*Required if courseID not provided. |
| courseID | integer | Yes\\* | v1.15 | Identifies the course delivering the evaluation. \\*Required if programID not provided. |
| evaluatee_userID | integer | Yes\\* | v1.15 | \\*Required for all evaluation types where the target is a person. |
| procedureID | integer | No\\* | v1.15 | \\*Required for all evaluations of procedures. |
| lectureID | integer | No\\* | v1.15 | \\*Required for all evaluations of conferences or sessions |
| globalserviceID | integer | No\\* | v1.15 | \\*Required if evaluation is of a service AND clinicnameID is not provided. Use schedules/services to get a list of service groups for a given program. |
| clinicnameID | integer | No\\* | v1.15 | \\*Required if evaluation is of a service AND globalserviceID is not provided. Use schedules/clinics to get a list of clinics defined for a given program or course. |
| notify | boolean | No | v1.15 | Pass TRUE to deliver an email notification to the evaluator. |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| responseID | unique identifier for evaluation response | integer | v1.15 | Value \"0\" indicates a failed delivery. |
example only
\n","key":"request","type":"text","value":"{\"userID\":97927}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/leaderboard","description":"Lists user and peers, with tallies of completed evaluations.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.15 | \nProvide the userID of a resident, student, or faculty member. Use users/residents, users/students, users/faculty, users/studentSearch, users/residentSearch to get userIDs. | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique identifier for a user | \ninteger | \nv1.15 | \n\n |
| first_name | \nfirst name of user | \nstring | \nv1.15 | \n\n |
| last_name | \nlast name of user | \nstring | \nv1.15 | \n\n |
| total | \nnumber of evaluations completed | \ninteger | \nv1.15 | \ncount includes evaluations completed over the last 180 days. | \n
| average | \naverage amount of time taken to complete an evaluation | \nstring | \nv1.01 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"programID\":890,\"list\":\"milestones\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/milestones","description":"Retrieves a list of the milestones, EPAs, or elements defined for a given program.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes | \nv1.01 | \n\n |
| list | \nstring | \nYes | \nv1.01 | \nValues to provide: \"milestones\", \"epas\", or \"elements\". | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| refID | \nunique index identifier | \ninteger | \nv1.01 | \nNote: only unique for its list type. | \n
| global_refID | \nunique global identifier | \ninteger | \nv1.01 | \nRefers to IDs used when standard \"packages\" are created for a specialty. This will only be poplulated if the program uses their standard package. | \n
| name | \nindex name, title of item in list | \nstring | \nv1.01 | \n\n |
| abbrev | \nindex abbreviation, abbreviation of item in list | \nstring | \nv1.01 | \n\n |
| status | \nstatus of item in list | \nstring | \nv1.01 | \nValues: \"Inactive\" or \"Active\". | \n
example only
\n","key":"request","type":"text","value":"{\"userID\":114783,\"type\":\"milestones\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/milestonesummary","description":"Provides a summary of milestone data for a given resident.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.15 | \n\n |
| type | \nstring | \nNo | \nv1.15 | \nValues list options: \"milestones\" (default), \"epas\", or \"elements\". | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| abbrev | \nindex abbreviation | \nstring | \nv1.15 | \n\n |
| name | \nindex name | \nstring | \nv1.15 | \n\n |
| average | \naverage level | \nfloat | \nv1.15 | \n\n |
| range | \nrange of responses | \nstring | \nv1.15 | \n\n |
| questions | \nnumber of tagged evaluation questions | \ninteger | \nv1.15 | \n\n |
| peer | \npeer average | \nfloat | \nv1.15 | \n\n |
| achieved | \nwhether or not milestone/epa/element has been achieved | \nstring | \nv1.15 | \nProvided if program uses Achievements. Response values include: \"yes\", \"no\", \"na\". | \n
example only
\n","key":"request","type":"text","value":"{\"evaluationID\":\"5419\",\"evaluation_type\":5,\"evaluator_userID\":77116,\"evaluatee_userID\":97927,\"programID\":481,\"answers\":[{\"questionID\":98508,\"answer_optionID\":2199},{\"questionID\":98509,\"answer_optionID\":2200},{\"questionID\":98510,\"answer_text\":\"Example comment about resident.\"}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/post","description":"Posts a completed evaluation into the MedHub database.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| evaluationID | \ninteger | \nYes | \nv1.00 | \n\n |
| evaluation_type | \ninteger | \nYes | \nv1.00 | \nUse evals/types to get a list of all available evaluation type IDs. | \n
| evaluator_userID | \ninteger | \nYes | \nv1.00 | \n\n |
| programID | \ninteger | \nYes* | \nv1.00 | \nDelivering programID required if courseID is not specified. | \n
| courseID | \ninteger | \nYes* | \nv1.06 | \nDelivering courseID required if programID is not specified. | \n
| evaluatee_userID | \ninteger | \nYes* | \nv1.00 | \nRequired for all evaluation types where the target is a person. | \n
| procedureID | \ninteger | \nNo* | \nv1.00 | \nRequired only for evaluations of procedures. | \n
| lectureID | \ninteger | \nNo* | \nv1.00 | \nRequired only for evaluations of conferences | \n
| globalserviceID | \ninteger | \nNo* | \nv1.00 | \nFor evaluations of services, either globalserviceID or clinicnameID is required. | \n
| clinicnameID | \ninteger | \nNo* | \nv1.00 | \nFor evaluations of services, either globalserviceID or clinicnameID is required. | \n
| rotation_start_date | \ndate | \nNo | \nv1.00 | \n\n |
| rotation_end_date | \ndate | \nNo | \nv1.00 | \n\n |
| issue_date | \ndate | \nNo | \nv1.00 | \nDefaults to today's date if not provided. | \n
| completion_date | \ndate | \nNo | \nv1.00 | \nDefaults to today's date if not provided. | \n
| signature | \nstring | \nNo | \nv1.16 | \nElectronic signature text, if signed. | \n
| answers | \narray | \nYes | \nv1.00 | \nArray containing answers to the evaluation questions. The array will need to include the following:
| \n
| status | \ninteger | \nNo | \nv1.06 | \nIndentifies the status of the evaluation. Values:
| \n
| responseID | \ninteger | \nNo | \nv1.12 | \nInclude when submitting answers for a previously delivered evaluation with a known responseID. When passing a responseID, no other input variables are required other than answers and status. | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| responseID | \nunique identifier for an evaluation response | \ninteger | \nv1.00 | \nValue = \"0\" if submission failed. | \n
| status_code | \nidentifies the status of the evaluation | \ninteger | \nv1.12 | \nValues:
| \n
example only
\n","key":"request","type":"text","value":"{\"programID\":481,\"userID\":97927,\"year\":\"2019\",\"half\":\"1\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/progress","description":"Retrieves the progress report scores for a specified resident and review period.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes | \nv1.01 | \n\n |
| userID | \ninteger | \nYes | \nv1.01 | \n\n |
| year | \ninteger | \nYes | \nv1.01 | \nFormat: 4-digit year (e.g. 2020) | \n
| half | \ninteger | \nYes | \nv1.01 | \nValues: \"1\", \"2\" | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| milestone_refID | \nunique identifier for milestone | \ninteger | \nv1.01 | \nUse evals/milestones to get a list of all milestones. | \n
| level | \ndreyfus level achieved by user on milestone | \nfloat | \nv1.01 | \n\n |
| notes | \nevaluation response title | \nstring | \nv1.01 | \nCCC notes (private). | \n
| status | \nstatus of report | \nstring | \nv1.01 | \nValues: \"Draft\" or \"Final\". | \n
example only
\n","key":"request","type":"text","value":"{\"responseID\":654050}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/status","description":"Retrieves the status of an evaluation request.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| responseID | \ninteger | \nYes | \nv1.00 | \n\n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| status_code | \nnumber representing hte current status of an evaluation request | \ninteger | \nv1.00 | \nValues:
| \n
| status_title | \nstatus description | \nstring | \nv1.00 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"userID\":97927}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/incomplete","description":"Retrieves a list of incomplete evaluations for a specified users.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \nuserID | \ninteger | \nyes | \nv0.90 | \n\n \n |
|---|
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| responseID | \nunique response identifier | \ninteger | \nv0.90 | \n\n |
| evaluationID | \nunique evaluation identifier | \ninteger | \nv0.90 | \n\n |
| eval_type | \nevaluation type identifier | \ninteger | \nv0.90 | \nuse evals/types to get a list of all available evaluation types | \n
| status | \nstatus of evaluation | \nstring | \nv0.90 | \n\n |
| eval_title | \ntitle of the evaluation response | \nstring | \nv1.16 | \n\n |
| issue_date | \ndate the evaluation was issued | \ndate | \nv1.16 | \n\n |
| late_date | \ndate when the evaluation is considered late | \ndate | \nv1.16 | \n\n |
| can_remove | \nevaluation can be deleted | \nboolean | \nv1.16 | \n\n |
| remove_req_comment | \ndeletion requires an additional comment | \nboolean | \nv1.16 | \n\n |
| must_sign | \nmust be signed electronically | \nboolean | \nv1.16 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"userID\":97927}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/evals/types","description":"Retrieves a list of all possible evaluation types.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| typeID | \nunique evaluation type identifier | \ninteger | \nv0.90 | \n\n |
| type_name | \nname of evaluation type | \nstring | \nv0.90 | \n\n |
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/appendDiagnosis","description":"| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
logID | int | y | Use procedures/logs to retrieve existing logIDs by program, user, and/or date. | |
typeID | int | y | The diagnosis typeID. Use procedures/diagnosisTypes to retrieve procedure types defined in a given program. | |
writein | string | n | If this is a custom procedure diagnosis without a defined type in the program, use this to populate the procedure name. | |
role | int | y | The role of the resident in this diagnosis. Use procedures/roles to retrieve roleIDs. | |
evaluate | boolean | n | Set to \"true\" if this should trigger an evaluation. The evaluation must be configured appropriately in the program's settings. |
| Field Name | Description | Data Type | Version | Notes |
|---|
example only
\n","key":"request","type":"text","value":"{\"logID\": 12345, \"typeID\": 6789, \"writein\": \"\", \"role\": 1, \"evaluation\": false}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/appendProcedure","description":"| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
logID | int | y | Use procedures/logs to retrieve existing logIDs by program, user, and/or date. | |
typeID | int | y | The procedure typeID. Use procedures/procedureTypes to retrieve procedure types defined in a given program. | |
writein | string | n | If this is a custom procedure without a defined type in the program, use this to populate the procedure name. | |
role | int | y | The role of the resident in this procedure. Use procedures/roles to retrieve roleIDs. | |
evaluate | boolean | n | Set to \"true\" if this procedure should trigger an evaluation. The evaluation must be configured appropriately in the program's settings. |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/deleteDiagnosis","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/deleteProcedure","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/diagnosisCounts","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":"{\"userID\": 83558, \"programID\": 4}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/diagnosisRequirements","description":"Retrieves a list of all diagnosis requirements for a resident/student in a given program/course.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| userID | integer | yes | 1.21 | userID of resident or student |
| programID | integer | yes\\* | 1.21 | \\*required if userID is resident |
| courseID | integer | yes\\* | 1.21 | \\*required is userID is student |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/diagnosisRequirementsProgress","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/diagnosisTypes","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/certifications","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/procedureCounts","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/locations","description":"Returns a list of all available procedure locations.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nyes* | \nv1.17 | \n*required if courseID not provided | \n
| courseID | \ninteger | \nyes* | \nv1.17 | \n*required if programID not provided | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| locationID | \nunique identifier of location | \ninteger | \nv1.17 | \n\n |
| location_name | \nname of location | \nstring | \nv1.17 | \n\n |
| default | \nidentifies if the location is set as the default location for the program/course | \nboolean | \nv1.19 | \noptional field; appears when location is the default | \n
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/logs","description":"Returns a list of procedure/diagnosis logs limited by date, program, and/or user.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nyes* | \nv1.18 | \n*required if programID or courseID is not provided | \n
| start_date | \ndate | \nyes* | \nv1.18 | \n*required if userID is not provided | \n
| end_date | \ndate | \nyes* | \nv1.18 | \n*required if userID is not provided | \n
| programID | \ninteger | \nyes* | \nv1.18 | \n*required if userID or courseID is not provided, otherwise optional | \n
| courseID | \ninteger | \nyes* | \nv1.18 | \n*required if userID or programID is not provided, otherwise optional | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| logID | \nunique identifier of procedure log | \ninteger | \nv1.18 | \n \n|
| locationID | \nunique identifier of procedure location | \ninteger | \nv1.18 | \nuse procedures/locations to get a list of all available locations | \n
| location | \nlocation name associated with locationID | \nstring | \nv1.18 | \n\n |
| date | \ndate of procedure log | \ndate | \nv1.18 | \n\n |
| supervisorID | \nunique identifier of selected procedure supervisor | \ninteger | \nv1.18 | \n\n |
| supervisor | \nsupervisor name associated with supervisorID | \nstring | \nv1.18 | \n\n |
| programID | \nunique identifier of program in which the log was recorded | \ninteger | \nv1.18 | \n\n |
| courseID | \nunique identifier of course in which the log was recorded | \ninteger | \nv1.18 | \n\n |
| mobile | \nidentifies if the log was recorded on a mobile device | \nboolean | \nv1.18 | \nTRUE if the log was recorded on a mobile device | \n
| fields | \nset of metadata fields included in the log | \narray | \nv1.18 | \nfields may vary by program/course | \n
| procedures | \nset of procedures selected in the log | \narray | \nv1.18 | \nthe following data will be included for each selected procedure:
| \n
| diagnoses | \nset of diagnoses selected in the log | \narray | \nv1.18 | \ndata provided is the same as the above for procedures, however the first field will be diagnosisID | \n
example only
\n","key":"request","type":"text","value":"{\"userID\":114615,\"programID\":481,\"locationID\":56,\"supervisorID\":77116,\"date\":\"2022-03-14\",\"mobile\":false,\"fields\":{\"patient_age\":\"21\",\"patient_gender\":\"F\"}}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/record","description":"Create a new log or update an existing one. You cannot add procedures or diagnoses to a log from this call; to do that use procedures/appendProcedure and/or procedures/appendDiagnosis.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| logID | integer | no\\* | v1.18 | \\\\*required when updating an existing log, otherwise a new logID is created |
| locationID | integer | no | v1.18 | |
| location | string | no | v1.18 | |
| date | date | yes | v1.18 | |
| supervisorID | integer | no | v1.18 | supervisor userID |
| supervisor | string | no | v1.18 | supervisor name |
| programID | integer | no | v1.18 | |
| courseID | integer | no | v1.18 | |
| mobile | boolean | no | v1.18 | set to TRUE if procedure was recorded on a mobile device |
| fields | array | no | v1.18 |
|
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| logID | unique log identifier | integer | v1.18 |
example only
\n","key":"request","type":"text","value":"{\"userID\": 82136, \"programID\": 4}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/procedureRequirements","description":"Retrieves list of all procedure requirements for a resident/student in a given program/course.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| userID | integer | yes | 1.21 | userID of resident or student |
| programID | integer | yes\\\\* | 1.21 | \\\\*required if userID is resident |
| courseID | integer | yes\\\\* | 1.21 | \\\\*required is userID is student |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":"{\"userID\": 83558, \"programID\": 4}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/procedureRequirementsProgress","description":"Retrieves a resident's/student's progress towards a program's defined procedure requirements.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| userID | integer | yes | 1.21 | userID of resident or student |
| programID | integer | yes\\* | 1.21 | \\\\\\\\\\*required if userID is resident |
| courseID | integer | yes\\* | 1.21 | \\\\\\\\\\*required if userID is student |
| Field Name | Description | Data Type | Version | Notes | ||
|---|---|---|---|---|---|---|
| requirement_name | procedure requirement name | string | 1.21 | |||
| logged | total number of logged procedures of type | integer | 1.21 | |||
| requirements | number of times the procedure type must logged with specified role to fulfill requirement | array | 1.21 | array will include: \"role_title\" and \"count\" for each role required. | ||
example only
\n","key":"request","type":"text","value":"{\"scope\": \"gme\", \"type\": \"procedure\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/roles","description":"Retrieves a list of all active procedure or diagnosis roles for given scope (gme/ume).
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| scope | string | yes | 1.10 | values include: \"ume\" or \"gme\" |
| type | string | yes | 1.10 | values include: \"procedure\", \"diagnosis\" |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| roleID | unique role identifier | integer | 0.90 | |
| role_title | role title | string | 0.90 |
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/settings","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/supervisors","description":"| Variable Name | Data Type | Required | Version | Notes | |
|---|---|---|---|---|---|
| ProgramID | yes\\* | ||||
| CourseID | yes\\* | ||||
| Offset | yes | Response is limited to 3000 users. Use this parameter to offset the users returned by n to get users beyond the first 3000 |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/supervisorsCount","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/procedureTypes","description":"Retrieves a list of all available procedure types in a given program or course.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nyes\\* | \n\n | required if courseID not specified | \n
| courseID | \ninteger | \nyes\\* | \n\n | required if programID not specified | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| typeID | \n\n | \n | \n | \n |
| procedure name | \n\n | \n | \n | \n |
| cpt_code | \n\n | \n | \n | \n |
| can_evaluate | \n\n | \n | \n | \n |
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/verificationsPending","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/supervisionLevels","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| N/A | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
example only
\n","key":"request","type":"text","value":"{\"procedureID\":\"108928\",\"supervisorID\":\"77116\",\"status\":\"1\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/procedures/verify","description":"| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| procedureID | \ninteger | \nyes | \nv1.22 | \n\n |
| supervisorID | \ninteger | \nyes | \nv1.22 | \nshould match supervisorID assigned to the log | \n
| status | \ninteger | \nyes | \nv1.22 | \npass \"1\" as verified, \"2\" as rejected | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| n/a | \nn/a | \nn/a | \nv1.22 | \nresponse will appear as \"true\" when request is successfully sent | \n
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/programs/all","description":"Retrieves a list of all active programs within the institution, regardless of access.
\n| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \nunique identifer for program | \ninteger | \nv0.90 | \n\n |
| program_name | \nfull name of program | \nstring | \nv0.90 | \n\n |
| program_abbrev | \nabbreviation of program name | \nstring | \nv0.90 | \n\n |
| program_level | \nheirarchy level of program | \ninteger | \nv0.90 | \nValues: 1 = department, 2 = subprogram | \n
| dept_programID | \nunique identifer for this program's department | \ninteger | \nv0.90 | \n\n |
no input required
\n","key":"request","type":"text","value":"{\"programID\":4}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/programs/info","description":"Get information about a given program.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| programID | integer | yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| programID | unique identifer for program | integer | ||
| program_name | full name of program | string | ||
| program_abbrev | abbreviation of program name | string | ||
| program_level | heirarchy level of program | integer | ||
| dept_programID | unique identifer for this program's department | integer | ||
| admin_userID | unique identifier (userID) of program admin user | integer | ||
| director_userID | unique identifier (userID) of program director | integer | userID will match a faculty userID, use users/faculty, users/facultyInfo, or users/facultySearch for more user details | |
| associate_director_userIDs | userIDs for all associate program directors | array | userID will match a faculty userID, use users/faculty, users/facultyInfo, or users/facultySearch for more user details |
example only
\n","key":"request","type":"text","value":"{\"courseID\":616,\"periodID\":1861}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/enrollment","description":"Retrieves a list of the students enrolled in a given course for a given period; includes recorded final grades.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| periodID | \ninteger | \nYes | \nv1.06 | \nUse schedules/periods to get a list of course period IDs. Use enrollmentperiods/periods to get more information about each periodID. | \n
| courseID | \ninteger | \nYes | \nv1.06 | \n\n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique identifer for student | \ninteger | \nv1.06 | \n\n |
| first_name | \nfirst name of student | \nstring | \nv1.06 | \n\n |
| last_name | \nlast name of student | \nstring | \nv1.06 | \n\n |
| grade | \nfinal grade recorded for student in the given course | \nstring | \nv1.06 | \n\n |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/years","description":"Retrieves a list of academic years and their IDs.
\n| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| rotationsetID | \nunique identifier for academic year | \ninteger | \nv1.00 | \n\n |
| start_date | \nacademic year start date | \ndate | \nv1.00 | \nFormat: YYYY-MM-DD | \n
| end_date | \nacademic year end date | \ndate | \nv1.00 | \nFormat: YYYY-MM-DD | \n
| rotationset_title | \ntitle of academic year | \nstring | \nv1.00 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/clinics","description":"Retrieves a list of clinic definitions for a specified program.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes* | \nv0.90 | \nRequired if courseID not specified | \n
| courseID | \ninteger | \nYes* | \nv1.06 | \nRequired if courseID not specified | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| clinicnameID | \nunique identifier for clinic | \ninteger | \nv1.00 | \n\n |
| clinic_name | \nfull name of clinic | \nstring | \nv1.00 | \n\n |
| clinic_abbrev | \nabbreviation of clinic name | \nstring | \nv1.00 | \n\n |
| clinic_status | \nstatus of clinic | \ninteger | \nv1.00 | \nValues: 1 = active, 0 = inactive | \n
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/clinicAssign","description":"Adds a clinic to the schedule.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
clinicnameID | integer | Yes | ||
userID | integer | Yes | Resident, Faculty, or Student | |
periodID | integer | Yes | ||
date | date | Yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
?? |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/clinicUnassign","description":"Supports clicID as part of the request.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
clinicnameID | integer | Yes | ||
userID | integer | Yes | Resident, Faculty, or Student | |
periodID | integer | Yes | ||
date | date | Yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
Confirm clinic assigment removed |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/clinicCreate","description":"Adds a clinic to the schedule.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
clinicName | integer | Yes | ||
clinicAbbreviation | integer | Yes | ||
residentSlots | integer | No | ||
facultySlots | integer | No | ||
studentSlots | integer | No | ||
siteID | integer | No | ||
programID | integer | Yes | Resident, Faculty, or Student | |
sharedprogramID | integer | Yes | ||
sharedclerkshipID | integer | Yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
Confirm item created with clinicnameID |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/clinicPeriodCreate","description":"Adds a new work period for our clinic.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
programID | integer | Yes | ||
periodName | integer | Yes | ||
status | integer | No | ||
startTime | time | Yes | Resident, Faculty, or Student | |
endTime | time | Yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
Confirm item created with periodID |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/clinicPeriods","description":"Retrieves a list of clinic work periods.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
programID | integer | Yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
periodID | integer | |||
periodName | integer | |||
status | integer | |||
startTime | time | |||
endTime | time |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/clinicAssignments","description":"Retrieves a list of clinic assignments.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
dateRange | date | Yes | ||
programID | integer | Yes | ||
userID | integer | No |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
clinicnameID | integer | |||
userID | integer | |||
periodID | integer | |||
programID | integer |
example only
\n","key":"request","type":"text","value":"{\"programID\":441}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/services","description":"Retrieves a list of service definitions for a specified program.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes | \nv1.00 | \n\n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| globalserviceID | \nunique identifier for service | \ninteger | \nv1.00 | \n\n |
| globalservice_name | \nfull name of clinic | \nstring | \nv1.00 | \n\n |
| globalservice_abbrev | \nabbreviation of service name | \nstring | \nv1.00 | \n\n |
| status | \nstatus of service | \ninteger | \nv1.00 | \nValues: 1 = active, 0 = inactive | \n
example only
\n","key":"request","type":"text","value":"{\"courseID\":356,\"rotationsetID\":20}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/periods","description":"Retrieves a list of open course date periods for a specified course and academic year.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| courseID | integer | Yes | v1.06 | Required if courseID not specified |
| rotationsetID | integer | Yes | v1.06 | DUse schedules/years to get a list of all academic year rotationsetIDs. |
| status | string | No | Defaults to \"open\", other values include: \"closed\", \"all\" |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| periodID | unique identifier for date period | integer | v1.06 | |
| start_date | start date of date period | date | v1.06 | Format: YYYY-MM-DD |
| end_date | end date of date period | date | v1.06 | Format: YYYY-MM-DD |
example only
\n","key":"request","type":"text","value":"{\"scheduleID\":1106,\"rotationsetID\":19}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/rotations","description":"Retrieves a list of course date periods for a specified course and academic year.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| scheduleID | \ninteger | \nYes | \nv1.00 | \nUse schedules/view to get a list of all schedules for a specified program | \n
| rotationsetID | \ninteger | \nYes | \nv1.00 | \nUse schedules/years to get a list of all academic year rotationsetIDs. | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| rotationID | \nunique identifier for a rotation period | \ninteger | \nv1.00 | \n\n |
| rotation_name | \nname of rotation period | \nstring | \nv1.00 | \n\n |
| start_date | \nstart date of rotation period | \ndate | \nv1.00 | \nFormat: YYYY-MM-DD | \n
| end_date | \nend date of rotation period | \ndate | \nv1.00 | \nFormat: YYYY-MM-DD | \n
example only
\n","key":"request","type":"text","value":"{\"programID\":481,\"rotationsetID\":19}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/view","description":"Retrieves a list of course date periods for a specified course and academic year.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes | \nv1.00 | \nUse programs/all to get a list of all programs | \n
| rotationsetID | \ninteger | \nYes | \nv1.00 | \nUse schedules/years to get a list of all academic year rotationsetIDs. | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| scheduleID | \nunique identifier for a schedule | \ninteger | \nv1.00 | \n\n |
| schedule_name | \nname of schedule | \nstring | \nv1.00 | \n\n |
| levels | \narray of applicable PGY levels (integers) that are assigned to the schedule | \narray | \nv1.00 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"programID\": 176, \"rotationsetID\": 23}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/shifts","description":"Retrieves shift/call definitions for a given program, shift, and/or academic year.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
programID | integer | Yes\\\\\\* | v1.09 | \\\\\\*Either programID or shiftID is required |
shiftID | integer | Yes\\\\\\* | v1.09 | \\\\\\*Either programID or shiftID is required |
rotationsetID | integer | No | v1.09 | Defaults to current academic year if not specified |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
shiftID | unique shift identifier | integer | v1.09 | |
shift_title | shift name | string | v1.09 | |
shift_abbrev | shift abbreviation | string | v1.09 | |
shift_type | shift type | integer | v1.09 | values 3=home call, 4=on-site shift/call |
shift_status | shift status | integer | v1.09 | values 1=active, 0=inactive |
call_flag | call designator | integer | v1.09 | values 1=call, 0=non-call |
limit_startDate | start date | date | v1.09 | format YYYY:MM:DD |
limit_endDate | end date | date | v1.09 | format YYYY:MM:DD |
slots_residents | max number of residents that can be assigned per day | integer | v1.09 | |
slots_faculty | max number of faculty that can be assigned per day | integer | v1.09 | |
slots_students | max number of students that can be assigned per day | integer | v1.09 | |
sites | array | array of linked sites | v1.09 | array contains the following key - value pairs: \"siteID\":\"value\" \"percent\":\"value\" |
times | array | array of times by day of week | v1.09 | array contains the following key-value pairs:
|
example only
\n","key":"request","type":"text","value":"{\"startDate\": \"2024-07-01\", \"endDate\": \"2025-06-30\", \"programID\": 608}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/shiftsSchedule","description":"Retrieves a populated shift/call schedule for a given date period.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
startDate | date | Yes | v1.09 | format YYYY:MM:DD |
endDate | date | Yes | v1.09 | format YYYY:MM:DD |
programID | integer | Yes\\\\* | v1.09 | \\\\*Either programID, shiftID, and/or userID is required |
shiftID | integer | Yes\\\\* | v1.09 | \\\\*Either programID, shiftID, and/or userID is required |
userID | integer | Yes\\\\* | v1.09 | \\\\*Either programID, shiftID, and/or userID is required |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
userID | integer | v1.09 | ||
shiftID | integer | v1.09 | ||
date | date | v1.09 |
example only
\n","key":"request","type":"text","value":"{\"programID\":436,\"rotationsetID\":23}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/services","description":"Retrieves a list of service definitions for a given program and/or schedule for a given academic year.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
scheduleID | int | Yes\\\\\\* | \\\\\\*Either scheduleID or programID is required | |
programID | int | Yes\\\\\\* | \\\\\\*Either scheduleID or programID is required | |
rotationsetID | int | Yes | v1.09 | Identifies academic year |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
serviceName | string | |||
serviceAbbreviation | string | |||
serviceId | int | |||
serviceGroup | int | |||
serviceType | int | |||
site | array | |||
description | string | |||
programId | int | |||
scheduleId | int | |||
rotationSetId | int |
example only
\n","key":"request","type":"text","value":"{\"serviceName\": \"Example Service C\", \"serviceAbbrev\":\"ESC\",\"serviceGroup\":8182, \"serviceType\":2, \"scheduleID\":910, \"rotationsetID\":24, \"siteID\":\"\", \"description\":\"This is an example service created by API.\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/serviceCreate","description":"Create a new service.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
serviceName | string | yes | ||
serviceAbbrev | string | yes | ||
serviceGroup | int | yes | ||
serviceType | int | yes | Possible values include:
| |
scheduleID | int | yes | Use schedules/view to retrieve scheduleIDs. | |
rotationsetID | int | yes | Identifies academic year. Use schedules/years to retrieve list of rotationsetIDs. | |
siteID | int | no | Use sites/list to retireve list of sites. | |
description | string | no |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
serviceID | unique identifer of newly created service | int |
example only
\n","key":"request","type":"text","value":"{\"serviceName\": \"Example Service C\", \"serviceAbbrev\":\"ESC\",\"serviceGroup\":8182, \"serviceType\":2, \"scheduleID\":910, \"rotationsetID\":24, \"siteID\":\"\", \"description\":\"This is an example service created by API.\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/serviceCreate","description":"Create a new service group through an API, so that groups of services can be efficiently organized and managed in the scheduling system.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
serviceGroupName | string | yes | ||
serviceGroupAbbrev | string | yes | ||
programID | int | yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
globalserviceID | unique identifer of newly created service | int |
example only
\n","key":"request","type":"text","value":"{\"shiftName\": \"Example Shift A\", \"shiftAbbrev\": \"EShA\", \"shiftType\": 3, \"timeStart\": \"08:00:00\", \"timeEnd\": \"18:00:00_0\", \"weekday\":\"1:2:3:4:6\",\"crossServiceA\": \"21953\",\"programID\":\"608\",\"rotationsetID\":24, \"shiftSlotsResidents\":1, \"shiftSlotsFaculty\":0, \"shiftSlotsStudents\":0, \"siteID\":\"\", \"shiftCall\":0, \"serviceID\":\"0\", \"shiftStatus\":\"1\", \"limitFlag\":0, \"limitDateStart\":\"\", \"limitDateEnd\":\"\" ,\"pagerNumber\":\"\",\"autogen\":0,\"autogenwknd\":0}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/shiftCreate","description":"Create a new service.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
shiftName | string | yes | ||
shiftAbbrev | string | yes | ||
shiftType | int | yes | Possible values include:
| |
timeStart | string/time | yes | Start time of shift in 24 hour format: \"##:##:##\" e.g. \"08:00:00\" = 8am, \"13:00:00\" = 1pm. | |
timeEnd | string/time | yes | Format is the same as timeStart, but adds \"_#\" to the end to identify if shift crosses into the next day. e.g. \"01:00:00_1\" would mean the shift will start on day 1, and end at 1am next day. | |
weekday | string | yes | Identifies days of the week this shift can be scheduled. Format: \"1:2:3:4:5:6:7\" where each number identifies a day of the week starting on Monday. e.g. \"1:2:3\" would mean the shift occurs on Mondays, Tuesdays, and Wednesdays. | |
crossServiceA | string | no | List of serviceIDs. Identifies any additional services that this shift is available for, multiple services can be provided in a \":\" delimited list. e.g. \"1234:9876:4567\" would identify 3 additional services. | |
programID | int | yes | ||
rotationsetID | int | yes | Identifies academic year. Use schedules/years to retrieve list of rotationsetIDs. | |
shiftSlotsResidents | int | no | ||
shiftSlotsFaculty | int | no | ||
shiftSlotsStudents | int | no | ||
siteID | int | no | ||
shiftCall | int | no | ||
serviceID | int | yes | ||
shiftStatus | int | no | ||
limitFlag | int | no | ||
limitDateStart | date | no | ||
limitDateEnd | date | no | ||
pagerNumber | string | no | ||
autogen | int | no | ||
autogenwknd | int | no |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
shiftnameID | unique identifier of newly created shift definition | int |
example only
\n","key":"request","type":"text","value":"{\"rotationsetID\":24, \"userID\":103567}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/serviceAssignments","description":"Retrieve a list of service assignments for a trainee for a given academic year.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
userID | int | yes | ||
rotationsetID | int | yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
userID | int | |||
scheduleID | int | |||
rotationsetID | int | |||
serviceID | int | |||
servicename | string | |||
abbrev | string | |||
slotID | int | |||
start_date | date | YYYY-MM-DD | ||
end_date | date | YYYY-MM-DD | ||
service_primary | Identifies whether or not the assignment is the trainee's primary assignment in cases where a trainee is assigned to multiple services with overlapping dates. | int | Values:
|
example only
\n","key":"request","type":"text","value":"{\"userID\": 120115, \"scheduleID\": 910, \"serviceID\": \"21953\", \"startDate\": \"2025-06-01\", \"endDate\": \"2025-06-30\", \"primary\": true}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/serviceAssign","description":"Create a new service assignment.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
userID | int | yes | ||
scheduleID | int | yes | ||
serviceID | int | yes | ||
startDate | date | yes | format: \"YYYY-MM-DD\" | |
endDate | date | yes | format: \"YYYY-MM-DD\" | |
primary | boolean | yes | Values: true or false. Identifies whether or not this new assignenment is the trainee's primary assignment if the trainee has more than one assignment in the same rotation period |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
slotIDs | Array of integers identifying the \"slotIDs\" created by this assignment. If only one assignment is created, only one slotID will be returned. | array |
example only
\n","key":"request","type":"text","value":"{\"userID\":\"83558\",\"scheduleID\":\"345\",\"serviceID\":\"33267\",\"startDate\":\"2025-07-01\",\"endDate\":\"2025-07-05\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/serviceUnassign","description":"Remove a service assignment.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
userID | int | yes | ||
scheduleID | int | yes\\* | ||
serviceID | int | yes | ||
startDate | date | yes | format: \"YYYY-MM-DD\" | |
endDate | date | yes | format: \"YYYY-MM-DD\" |
Success
\n","urlObject":{"path":["schedules","serviceUnassign"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"f76c8052-5090-4ece-8e57-140bce36cf77","name":"schedules/serviceUnassign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only","key":"request","type":"text","value":"{\"userID\":\"83558\",\"scheduleID\":\"345\",\"serviceID\":\"33267\",\"startDate\":\"2025-07-01\",\"endDate\":\"2025-07-05\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/serviceUnassign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 01 Jul 2025 16:00:12 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Set-Cookie","value":"Ascend_Session_Cookie=!fVPAolk6IwAkoU8qRqNhVZ9BpnNL5p6CqG/BgzyTNTDNnWTzjLQ+VbW6D1qUXRwoor3RnjAKDy/ZEVU=; path=/; Httponly; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"95871d6a2906a599-ORD"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\"\n}"}],"_postman_id":"d4839393-397c-4c64-b8e3-946bf70aca51"},{"name":"schedules/shiftAssign","id":"b6c04dc5-2be2-4afe-b5b5-9feec2f8ccb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only
\n","key":"request","type":"text","value":"{\"shiftnameID\": 1234, \"userID\": 98765, \"shiftDate\": \"2026-03-26\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/shiftAssign","description":"Create a new shift assignment.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
shiftnameID | integer | Yes | The unique ID of the shift being assigned. | |
userID | integer | Yes | The user ID of the faculty or resident being added to the shift/call. | |
shiftDate | date | Yes | The date of the shift/call. Date format: YYYY-MM-DD. | |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
shiftID | Unique shift assignment identifier | integer | This ID refers to the shift assignment. | |
slotID | Unique identifier of schedule assignment | integer | Refers to both the date/block and service combined. Think of it as the \"slot\" a resident is scheduled in. This is returned because shifts are associated with service assignments. |
example only
\n","key":"request","type":"text","value":"{\"shiftnameID\": 1234, \"userID\": 98765, \"shiftDate\": \"2026-03-26\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schedules/shiftUnassign","description":"Remove an existing shift/call assignment, to enable the management of scheduling duties.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
shiftnameID | integer | Yes | The unique ID of the shift being aassigned. | |
userID | integer | Yes | The unique ID of the faculty or resident being added to the shift/call. | |
shiftDate | date | Yes | The date of the shift/call. Date format: YYYY-MM-DD. | |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
shiftID | Unique shift assignment identifier | integer | This ID refers to the shift assignment. | |
slotID | Unique schedule assignment ID | integer | Refers to both the date/block and service combined. Think of it as the \"slot\" a resident is scheduled in. This is returned because shifts are associated with service assignments. |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/schools/access","description":"Get a list of defined, active schools.
\n| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| schoolID | \nunique school identifer | \ninteger | \n\n | \n |
| school_name | \nname of school | \nstring | \n\n | \n |
| school_abbrev | \nabbreviation of school name | \nstring | \n\n | \n |
example only
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/sites/list","description":"Retrieve a list of sites associated with a medhub URL, so that site details such as site ID, site name, and others can be viewed and managed.
\nNone
\n| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
siteID | ID of site | integer | ||
siteName | Name of site | string | ||
siteShortName | Short name of site | string | ||
abbreviation | Abbreviation of name of site | string | ||
sitedesignationID | integer | |||
sitedesignation | None, IRF, IPF, NHL/NPS | integer | ||
costreportName | string | |||
costreportId | integer | |||
status | string | |||
sitetypeID | integer | |||
sitetype | string | |||
imePercentage | integer | |||
dgmePercentage | integer | |||
siteBilled | Y/N | string | ||
siteContact | string | |||
siteAddress | string | |||
siteNotes | string | |||
programIDs | List of associated programIDs | integer | ||
clerkshipIDs | List of associated clerkshipIDs | integer | ||
iID | integer | |||
schoolID | Unique school identifier | integer |
Retrieve details about a defined student group by groupID.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
groupID | integer | Yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
groupID | unique identifer of student group | integer | ||
group_name | name of student group | string | ||
courseID | unique identifier of the course in which the student group is defined | integer | ||
status | current status of the student group | integer | v1.06 | 1 = active 0 = inactive |
order | order value of the student group in the list of defined student groups | integer | Ex: If order=3, this student groups is listed 3rd in the courses list of student groups | |
students | array of userIDs identifying the students assigned to the group | array | v1.06 |
example only
\n","key":"request","type":"text","value":"{\"username\":\"Chung.Haas\",\"status\":\"inactive\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentSearch","description":"Search for a student by name, username, or studentID. Response will include all students with data LIKE what is given. If multiple are provided, these will search using an “AND” joiner, excluding results that don’t match all filters.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| name | \nstring | \nYes* | \nv1.06 | \nrequired if username or employeeID not provided | \n
| username | \nstring | \nYes* | \nv1.06 | \nrequired if name or employeeID not provided | \n
| employeeID | \nstring | \nYes* | \nv1.06 | \nrequired if name or username not providedD | \n
| status | \nstring | \nNo | \n\n | values include: \"active\", \"inactive\", \"incoming\" | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique user identifer | \ninteger | \nv1.06 | \n\n |
| name_last | \nlast name of student | \nstring | \nv1.06 | \n\n |
| name_first | \nfirst name of student | \nstring | \nv1.06 | \n\n |
| email address | \nstring | \nv1.06 | \n\n | |
| username | \nstudent's MedHub username | \nstring | \nv1.06 | \n\n |
| employeeID | \nstudent's employee ID | \nstring | \nv1.06 | \n\n |
| typeID | \nstudent type assigned in MedHub | \ninteger | \nv1.06 | \nuse users/studentTypes to get a list of all student types | \n
| level | \nmedical school year | \ninteger | \nv1.06 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"username\":\"Alleen\",\"status\":\"active\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentSearch","description":"Search for a resident by name, username, or employeeID. Response will include all residents with data LIKE what is given. If multiple are provided, these will search using an “AND” joiner, excluding results that don’t match all filters.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| name | \nstring | \nYes* | \nv0.90 | \nrequired if username or employeeID not provided | \n
| username | \nstring | \nYes* | \nv0.90 | \nrequired if name or employeeID not provided | \n
| employeeID | \nstring | \nYes* | \nv0.90 | \nrequired if name or username not providedD | \n
| status | \nstring | \nNo | \n\n | values include: \"active\", \"inactive\", \"incoming\" | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique user identifer | \ninteger | \nv0.90 | \n\n |
| name_last | \nlast name of resident | \nstring | \nv0.90 | \n\n |
| name_first | \nfirst name of resident | \nstring | \nv0.90 | \n\n |
| email address | \nstring | \nv0.90 | \n\n | |
| username | \nresident's MedHub username | \nstring | \nv0.90 | \n\n |
| employeeID | \nresident's employee ID | \nstring | \nv0.90 | \n\n |
| typeID | \nresident type assigned in MedHub | \ninteger | \nv0.90 | \nuse users/residentTypes to get a list of all resident types | \n
| level | \nPG training year | \ninteger | \nv0.90 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"username\":\"Alleen\",\"status\":\"active\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentDemographics","description":"Get a list of Resident's demographic data.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
name | string | Yes\\* | v0.90 | required if username or employeeID not provided |
username | string | Yes\\* | v0.90 | required if name or employeeID not provided |
employeeID | string | Yes\\* | v0.90 | required if name or username not providedD |
status | string | No | values include: \"active\", \"inactive\", \"incoming\" |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
userID | unique user identifer | integer | v0.90 | |
name_last | last name of resident | string | v0.90 | |
name_first | first name of resident | string | v0.90 | |
email | email address | string | v0.90 | |
username | resident's MedHub username | string | v0.90 | |
employeeID | resident's employee ID | string | v0.90 | |
typeID | resident type assigned in MedHub | integer | v0.90 | use users/residentTypes to get a list of all resident types |
level | PG training year | integer | v0.90 |
example only
\n","key":"request","type":"text","value":"{\"username\":\"Alleen\",\"status\":\"active\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentDemographicsChangeHistory","description":"Get information about changes to a Resident's demographic data (change history).
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
userID | integer | Yes\\* | \\*Either userID or field_name must be provided. | |
field_name | string | Yes\\* | \\*Either userID or field_name must be provided. | |
start_date | integer | No | Date range is optional. Defaults to past year if not provided. | |
end_date | integer | No | Date range is optional. Defaults to past year if not provided. | |
status | integer | No |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
userID | unique user identifier | integer | ||
field_name | the field that was changed | string | e.g., status_RefID | |
old_value | previous value | integer | ||
new_value | what the value changed to | integer | ||
changed_at | date and time of change to speicified field | integer | yyyy-mm-dd; hrs-min-sec |
example only
\n","key":"request","type":"text","value":"{\"name\":\"John\",\"status\":\"active\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/facultySearch","description":"Search for faculty by name, username, or employeeID. Response will include all residents with data LIKE what is given. If multiple are provided, these will search using an “AND” joiner, excluding results that don’t match all filters.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| name | string | Yes\\\\* | v0.90 | required if username or employeeID not provided |
| username | string | Yes\\\\* | v0.90 | required if name or employeeID not provided |
| employeeID | string | Yes\\\\* | v0.90 | required if name or username not providedD |
| status | string | No | values include: \"active\", \"inactive\", \"incoming\" |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| userID | unique user identifer | integer | ||
| name_last | last name of resident | string | ||
| name_first | first name of resident | |||
| email address | ||||
| username | resident's MedHub username | string | ||
| employeeID | resident's employee ID | |||
| courseID/programID | unique identifier for program or course |
example only
\n","key":"request","type":"text","value":"{\"username\":\"ccoord\",\"name\":\"Coordinator\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/courseCoordinatorSearch","description":"Performs a simple search of course coordinators by name, employee ID and/or username. At least one of these search filters is required.\nIf multiple are provided, these will search using an “AND” joiner, excluding results that don’t match all filters.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| name | \nstring | \nYes* | \nv1.28 | \n*required if username or employeeID not specified | \n
| username | \nstring | \nYes* | \nv1.28 | \n*required if name or employeeID not specified | \n
| employeeID | \nstring | \nYes* | \nv1.28 | \n*required if name or username not specified | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique user identifer | \ninteger | \nv1.28 | \n\n |
| name_last | \nlast name | \nstring | \nv1.28 | \n\n |
| name_first | \nfirst name | \nstring | \nv1.28 | \n\n |
| email address | \nstring | \nv1.28 | \n\n | |
| username | \nMedHub username | \nstring | \nv1.28 | \n\n |
| employeeID | \nemployee ID | \nstring | \nv1.28 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"courseID\":233}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/students","description":"Lists the active students in a specified course
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| courseID | \ninteger | \nYes | \nv1.06 | \n\n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique user identifer | \ninteger | \nv1.06 | \n\n |
| name_last | \nlast name of student | \ntext | \nv1.06 | \n\n |
| name_first | \nfirst name of student | \ntext | \nv1.06 | \n\n |
| email address | \ntext | \nv1.06 | \n\n | |
| username | \nstudent's MedHub username | \ntext | \nv1.06 | \n\n |
| employeeID | \nstudent's employee ID | \ntext | \nv1.06 | \n\n |
| typeID | \nstudent type assigned in MedHub | \ninteger | \nv1.06 | \nuse users/studentTypes to get a list of all student types | \n
| level | \nmedical school year | \ninteger | \nv1.06 | \n\n |
Adds a training history record for a student.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
userID | integer | Yes | ||
startDate | date | Yes | ||
endDate | date | Yes | ||
trainingType | integer | Yes | ||
level | integer | Yes | ||
typeID | integer | Yes | ||
visiting_schoolID | integer | Yes | ||
clerkshipID | integer | Yes | ||
location | text | Yes | ||
otherTraining | test | Yes |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
trainingID |
Gets a list of student training types.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
schooID | integer | |||
trainingTypeID | integer | |||
training_type_name | integer |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
training_typeA |
example only
\n","key":"request","type":"text","value":"{\"programID\":890}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residents","description":"Lists the active (by default) residents in a specified program (by default). You may include a status parameter to retrieve incoming residents.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
programID | integer | Yes | v0.90 | |
status | string | No | Optionally include
|
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
userID | unique user identifer | integer | v0.90 | |
name_last | last name of resident | text | v0.90 | |
name_first | first name of resident | text | v0.90 | |
email | email address | text | v0.90 | |
username | resident's MedHub username | text | v0.90 | |
employeeID | resident's employee ID | text | v0.90 | |
typeID | resident type assigned in MedHub | integer | v0.90 | use users/residentTypes to get a list of all resident types |
level | PG training year | integer | v0.90 |
example only
\n","key":"request","type":"text","value":"{\"userID\":97927}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentTraining","description":"Retrieves training history records for a given resident.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \n\n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| trainingID | \nunique training record identifier | \ninteger | \nv1.05 | \n\n |
| training_typeID | \nunique identifier of training type | \ninteger | \nv1.05 | \n\n |
| training_type_name | \nname of training type | \nstring | \nv1.05 | \n\n |
| start_date | \nstart date of training record | \ndate | \nv1.05 | \nformat: \"YYYY-MM-DD\" | \n
| end_date | \nend date of training record | \ndate | \nv1.05 | \nformat: \"YYYY-MM-DD\" | \n
| level | \nlevel of training/PGY | \ninteger | \nv1.05 | \n\n |
| programID | \nunique identifier of program | \ninteger | \nv1.05 | \n\n |
| program_name | \nname of program | \nstring | \nv1.05 | \n\n |
| inhouse | \nin-house training record | \nboolean | \nv1.05 | \ntrue=in-house, false=not in-house | \n
| location | \nlocation of training | \nstring | \nv1.05 | \n\n |
| typeID | \nunique identifer of resident type | \ninteger | \nv1.05 | \n\n |
| type_name | \nname of resident type | \nstring | \nv1.05 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"programID\":890}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/faculty","description":"Lists the active faculty in a specified program.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes | \nv0.90 | \n\n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique user identifier | \ninteger | \nv0.90 | \n\n |
| name_last | \nlast name | \ntext | \nv0.90 | \n\n |
| name_first | \nfirst name | \ntext | \nv0.90 | \n\n |
| email address | \ntext | \nv0.90 | \n\n | |
| username | \nMedHub username | \ntext | \nv0.90 | \n\n |
| employeeID | \nemployee ID | \ntext | \nv0.90 | \n\n |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentFields","description":"Retrieves a list of all student demographic fields defined for the institution that can be used when creating or updating a student account.
\nNote: these fields will vary by institution as different insitutions enable/disable fields and/or create custom fields.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
n/a |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
array of demographic fields | returns an array of all student demographic fields for the insitution | array | v1.20 | List of fields will be variable depending on the institution. Attributes of each field will include:
|
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentFields","description":"Retrieves a list of all resident demographic fields defined for the institution that can be used when creating or updating a resident account.
\nNote: these fields will vary by institution as different insitutions enable/disable fields and/or create custom fields.
| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| n/a | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| array of demographic fields | \nreturns an array of all resident demographic fields for the insitution | \narray | \nv1.21 | \nList of fields will be variable depending on the institution. Attributes of each field will include: \n
| \n
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/facultyFields","description":"Retrieves a list of all faculty demographic fields defined for the institution that can be used when creating or updating a faculty account.
| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| n/a | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| array of demographic fields | \nreturns an array of all faculty demographic fields for the insitution | \narray | \nv1.21 | \nList of fields will be variable depending on the institution. Attributes of each field will include: \n
| \n
example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentInfo","description":"Provides all demographic data for a single student.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.06 | \n\n |
Varies by institution based on enabled demographic fields. Custom demographic fields are also included.
\n","urlObject":{"path":["users","studentInfo"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"43d2ae61-1bb9-4df8-8b8a-bf4209e9b70d","name":"users/studentInfo","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"{\"userID\": \t98634}","description":"example only","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentInfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 May 2020 18:55:41 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"name_last\": \"Aashaw\",\n \"name_first\": \"Mary\",\n \"name_middle\": \"James\",\n \"name_alias\": null,\n \"email\": \"demotest2@medhub.com\",\n \"username\": \"tmpmdishaw\",\n \"studentID\": \"123445\",\n \"typeID\": \"1\",\n \"type_name\": \"Medical Student\",\n \"level\": \"3\",\n \"status\": \"active\",\n \"birth_place\": null,\n \"birth_date\": \"1983-07-01\",\n \"gender\": null,\n \"citizenship\": null,\n \"ethnicity\": null,\n \"start_date\": null,\n \"phone_home\": null,\n \"phone_work\": null,\n \"phone_mobile\": null,\n \"address_current_line1\": null,\n \"address_current_line2\": null,\n \"address_current_city\": null,\n \"address_current_state\": null,\n \"address_current_zipcode\": null,\n \"address_current_country\": null,\n \"address_permanent_line1\": null,\n \"address_permanent_line2\": null,\n \"address_permanent_city\": null,\n \"address_permanent_state\": null,\n \"address_permanent_zipcode\": null,\n \"address_permanent_country\": null,\n \"address_other_description\": null,\n \"address_other_line1\": null,\n \"address_other_line2\": null,\n \"address_other_city\": null,\n \"address_other_state\": null,\n \"address_other_zipcode\": null,\n \"address_other_country\": null,\n \"institution_abbreviation\": \"Sand\",\n \"first_name\": \"Mary\",\n \"last_name\": \"Aashaw\",\n \"email_address\": \"demotest2@medhub.com\",\n \"active_y_n\": \"1\",\n \"access\": \"0\",\n \"current_y_n\": \"1\",\n \"training_year\": \"3\",\n \"banner_id\": \"123445\",\n \"date_of_birth\": \"1983-07-01\",\n \"prev_last_name\": null,\n \"aamc_identifier\": \"4342434234\",\n \"npi\": null,\n \"place_of_birth\": null,\n \"country_of_birth\": null,\n \"ethnic_origin\": null,\n \"visa_type\": null,\n \"visa_issued\": null,\n \"visa_expires\": null,\n \"marital_status\": null,\n \"spouse_name\": null,\n \"children\": null,\n \"demographics_comments\": null,\n \"pref_contact\": \"Email\",\n \"home_phone\": null,\n \"cell_phone\": null,\n \"other_work_phone\": null,\n \"pager\": \"12345678\",\n \"email_secondary\": null,\n \"mailbox\": null,\n \"current_address_address_1\": null,\n \"current_address_address_2\": null,\n \"current_address_city\": null,\n \"current_address_state\": null,\n \"current_address_country\": null,\n \"current_address_zipcode\": null,\n \"internal_address_address_1\": null,\n \"internal_address_address_2\": null,\n \"internal_address_city\": null,\n \"internal_address_state\": null,\n \"internal_address_country\": null,\n \"internal_address_zipcode\": null,\n \"permanent_address_address_1\": null,\n \"permanent_address_address_2\": null,\n \"permanent_address_city\": null,\n \"permanent_address_state\": null,\n \"permanent_address_country\": null,\n \"permanent_address_zipcode\": null,\n \"other_address_description\": null,\n \"other_address_address_1\": null,\n \"other_address_address_2\": null,\n \"other_address_city\": null,\n \"other_address_state\": null,\n \"other_address_country\": null,\n \"other_address_zipcode\": null,\n \"emergency_address_contact_name\": null,\n \"emergency_address_relation\": null,\n \"emergency_address_phone_number\": null,\n \"emergency_address_address_1\": null,\n \"emergency_address_address_2\": null,\n \"emergency_address_city\": null,\n \"emergency_address_state\": null,\n \"emergency_address_zipcode\": null,\n \"emergency_address_country\": null,\n \"contact_comments\": null,\n \"education_comments\": null,\n \"certifications_comments\": null,\n \"senesac_test\": null,\n \"hobbies\": null,\n \"test_scores_comments\": null,\n \"matric_date\": null,\n \"immunizations_comments\": null,\n \"forms_files_comments\": null,\n \"awards_discipline_comments\": null,\n \"visa_immigration_comments\": null,\n \"orientation_date\": null,\n \"orientation_comments\": null,\n \"verified\": \"0\",\n \"training_history_comments\": null,\n \"end_date_proj\": null,\n \"termin_date\": null,\n \"hospital_experience\": null,\n \"health_issues\": null,\n \"nrmp_number\": null,\n \"withdraw_date\": null,\n \"withdraw_notes\": null,\n \"student_type\": \"In-State (OK)\",\n \"insurance_comments\": null,\n \"military\": \"(not indicated)\",\n \"residency\": \"(unknown)\",\n \"academic_plan\": \"(unknown)\",\n \"enrollment_comments\": null,\n \"compliance_comments\": null,\n \"aamc_comments\": null,\n \"ferpa_hold\": \"No\",\n \"preferred_name\": null,\n \"transfer_in\": null,\n \"transfer_out\": null,\n \"exchange\": null,\n \"probation_status\": null,\n \"probation_ever\": null,\n \"aoa_member\": \"Yes\",\n \"discussion_room\": null,\n \"module\": null,\n \"grad_year_projected\": \"2019\",\n \"grad_year_actual\": null,\n \"quartile\": null,\n \"action\": null,\n \"action_date\": null,\n \"professionalism_comments\": null,\n \"desk\": null,\n \"degree\": null,\n \"testing\": \"yes\",\n \"graduated\": null,\n \"custom_text_9\": null,\n \"does_this_show_on_the_ad_hoc_report\": null,\n \"cell_phone_carrier\": null,\n \"select_hobby\": null,\n \"major_undergraduate\": null,\n \"major_graduate\": null,\n \"test_education_field\": null\n}"}],"_postman_id":"daad81d9-f9a7-436f-bc66-9b36bbcee1a5"},{"name":"users/residentInfo","id":"446640ae-0833-436f-abe0-47e9d44081ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only
\n","key":"request","type":"text","value":"{\"userID\":97927}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentInfo","description":"Returns all demographic data for a single resident.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.05 | \n\n |
Varies by institution based on enabled demographic fields. Custom demographic fields are also included.
\n","urlObject":{"path":["users","residentInfo"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"4070a25a-a21b-48bf-bba7-05ea56ab4d63","name":"users/residentInfo","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"{\"userID\":97927}","description":"example only","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentInfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Apr 2020 12:23:53 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"name_last\": \"Archuleta\",\n \"name_first\": \"Alleen\",\n \"name_middle\": null,\n \"name_alias\": null,\n \"email\": \"test31233@medhub.com\",\n \"username\": \"Alleen\",\n \"employeeID\": \"0123456789\",\n \"typeID\": \"2\",\n \"type_name\": \"Resident\",\n \"programID\": \"481\",\n \"program_name\": \"Internal Medicine - PRIMARY CARE\",\n \"level\": \"5\",\n \"status\": \"active\",\n \"birth_place\": null,\n \"birth_date\": \"1987-07-27\",\n \"gender\": \"F\",\n \"citizenship\": \"US\",\n \"ethnicity\": \"NSPEC\",\n \"school_name\": \"University of Alabama School of Medicine\",\n \"school_degree\": \"B.A.\",\n \"school_start_date\": \"2008-08-18\",\n \"school_end_date\": \"2012-04-20\",\n \"school_graduated\": true,\n \"phone_home\": \"248-200-2000\",\n \"phone_work\": \"734-300-3000\",\n \"phone_mobile\": \"313-400-4000\",\n \"address_current_line1\": \"719 Hamilton Road\",\n \"address_current_line2\": null,\n \"address_current_city\": \"Demotown\",\n \"address_current_state\": \"MI\",\n \"address_current_zipcode\": \"44444\",\n \"address_current_country\": \"United States\",\n \"address_permanent_line1\": \"12345 Main St\",\n \"address_permanent_line2\": null,\n \"address_permanent_city\": \"Dexter\",\n \"address_permanent_state\": \"MI\",\n \"address_permanent_zipcode\": \"48130\",\n \"address_permanent_country\": null,\n \"address_other_description\": \"My PO Box\",\n \"address_other_line1\": \"PO Box 5000\",\n \"address_other_line2\": \"j-1\",\n \"address_other_city\": \"Ann Arbor\",\n \"address_other_state\": \"MI\",\n \"address_other_zipcode\": \"44445\",\n \"address_other_country\": null,\n \"projected_end_date\": \"2015-07-01\",\n \"termination_date\": \"2019-07-30\",\n \"ssn\": \"000-01-1486\",\n \"dea\": \"123456\",\n \"institution_abbreviation\": \"Sand\",\n \"first_name\": \"Alleen\",\n \"last_name\": \"Archuleta\",\n \"email_address\": \"test31233@medhub.com\",\n \"active\": \"1\",\n \"access\": \"1\",\n \"current_y_n\": \"1\",\n \"user_id\": \"97927\",\n \"pgy_level_current\": \"5\",\n \"empl_id\": \"0123456789\",\n \"date_of_birth\": \"1987-07-27\",\n \"pref_contact\": \"Email\",\n \"home_phone\": \"248-200-2000\",\n \"pref_or_nickname\": null,\n \"appt_type\": \"Resident\",\n \"place_of_birth\": null,\n \"ctry_of_citizenship\": \"United States\",\n \"ethnic_origin\": \"Not Specified\",\n \"marital_status\": null,\n \"spouse_name\": null,\n \"children\": null,\n \"demographics_comments\": \"Mike res view test\",\n \"cell_phone\": \"313-400-4000\",\n \"work_phone\": \"734-300-3000\",\n \"pager\": \"333-333-3333\",\n \"current_address_address_1\": \"719 Hamilton Road\",\n \"current_address_address_2\": null,\n \"current_address_city\": \"Demotown\",\n \"current_address_state\": \"MI\",\n \"current_address_country\": \"United States\",\n \"current_address_zipcode\": \"44444\",\n \"permanent_address_address_1\": \"12345 Main St\",\n \"permanent_address_address_2\": null,\n \"permanent_address_city\": \"Dexter\",\n \"permanent_address_state\": \"MI\",\n \"permanent_address_country\": null,\n \"permanent_address_zipcode\": \"48130\",\n \"other_address_description\": \"My PO Box\",\n \"other_address_address_1\": \"PO Box 5000\",\n \"other_address_address_2\": \"j-1\",\n \"other_address_city\": \"Ann Arbor\",\n \"other_address_state\": \"MI\",\n \"other_address_country\": null,\n \"other_address_zipcode\": \"44445\",\n \"education_comments\": null,\n \"certifications_comments\": \"testing\",\n \"training_history_comments\": \"Can you see me?\\r\\nno\",\n \"post_residency\": \"0\",\n \"other\": null,\n \"test_scores_comments\": null,\n \"gme_comments\": \"Can she see this?\",\n \"finance_comments\": null,\n \"verified_credentialed\": \"1\",\n \"committee_approval_date\": null,\n \"ecca_approval_date\": null,\n \"verification_comments\": null,\n \"irp_limit_date\": \"2018-06-21\",\n \"contact_comments\": null,\n \"forms_files_comments\": \"See internal file for more\",\n \"compulsivity_index_comments\": null,\n \"program_comments\": \"Can she see this?\",\n \"fax_number\": null,\n \"access_code\": null,\n \"immunizations_comments\": null,\n \"practitioner_id\": \"22244\",\n \"npi\": null,\n \"email_secondary\": \"username@domain.co\",\n \"orientation_date\": \"2019-07-01\",\n \"awards_discipline_comments\": null,\n \"visa_immigration_comments\": null,\n \"mailbox\": null,\n \"country_of_birth\": null,\n \"internal_address_address_1\": null,\n \"internal_address_address_2\": null,\n \"internal_address_city\": null,\n \"internal_address_state\": null,\n \"internal_address_country\": null,\n \"internal_address_zipcode\": null,\n \"orientation_comments\": null,\n \"projected_start_date\": null,\n \"trainee_type_current\": \"Resident\",\n \"emergency_address_contact_name\": null,\n \"emergency_address_relation\": null,\n \"emergency_address_phone_home\": null,\n \"emergency_address_address_1\": null,\n \"emergency_address_address_2\": null,\n \"emergency_address_city\": null,\n \"emergency_address_state\": null,\n \"emergency_address_zipcode\": null,\n \"emergency_address_email\": null,\n \"aamc_number\": null,\n \"cost_center\": null,\n \"alumni_dues\": null,\n \"compensation\": null,\n \"us_entry_date\": null,\n \"test_benefits\": \"(unknown)\",\n \"parking_form\": \"(unknown)\",\n \"data_coll_form\": \"(unknown)\",\n \"compliance_comments\": null,\n \"aoa_member\": \"0\",\n \"last_updated\": null,\n \"deceased\": null,\n \"job_code\": \"0\",\n \"custom_text_4\": null,\n \"encode_number\": null,\n \"shoe_size\": \"TEst Does this show for Aleen\",\n \"ghhs_award\": null,\n \"emergency_test\": null,\n \"test_date_field\": null,\n \"resident_review_date\": null,\n \"education_date\": null,\n \"shoe_size_2\": null,\n \"new_hire_license_application_url\": null,\n \"phone_alumni\": \"7345802000\",\n \"email_alumni\": \"username@domain.com\",\n \"alumni_comments\": null,\n \"alumni_address_address_1\": \"123 Sesame Street\",\n \"alumni_address_address_2\": \"\",\n \"alumni_address_city\": \"Los Angeles\",\n \"alumni_address_state\": \"California\",\n \"alumni_address_country\": \"USa\",\n \"alumni_address_zipcode\": \"90210\",\n \"alumni\": \"1\",\n \"emergency_address_email_address\": null,\n \"emergency_address_phone_cell\": null,\n \"emergency_address_phone_work\": null,\n \"malpractice_claims\": null,\n \"pets_name\": null,\n \"custom_text_12\": null,\n \"va_field\": null,\n \"current_academic_year_status\": null,\n \"undergrad_major\": null,\n \"score\": null,\n \"opt_out_emergency_contact\": null,\n \"county\": null,\n \"test_demo_field\": null,\n \"work_address_test\": null,\n \"testing\": null,\n \"committee\": null\n}"}],"_postman_id":"446640ae-0833-436f-abe0-47e9d44081ed"},{"name":"users/facultyInfo","id":"f148e826-84c9-4675-b1a4-ba4fca726273","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"{\"userID\":\t\"116358\"}","description":"example only
\n","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/facultyInfo","description":"Provides all demographic data for a single faculty account.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \n\n | \n |
Varies by institution based on enabled demographic fields.
\n","urlObject":{"path":["users","facultyInfo"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"ca93f050-cdd9-4228-a9e8-96e84acdff24","name":"users/facultyInfo","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"{\"userID\":\t\"116358\"}","description":"example only","type":"text"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/facultyInfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 May 2020 20:18:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"institution_abbreviation\": \"Sand\",\n \"username\": \"APIExample2\",\n \"first_name\": \"API\",\n \"last_name\": \"ExampleFaculty\",\n \"email\": \"APITest@test.com\",\n \"specialty\": null,\n \"contact_phone\": \"555-555-5555\",\n \"contact_pager\": null,\n \"title\": null,\n \"interests_clinical\": null,\n \"interests_research\": null,\n \"contact_pager_alpha\": null,\n \"contact_fax\": null,\n \"work_address_contact_address_work\": null,\n \"home_address_contact_address_home\": null,\n \"biography\": null,\n \"photo\": \"0\",\n \"notes\": null,\n \"children_names\": null,\n \"employeeid\": \"1234API\",\n \"name_suffix\": \"III\",\n \"contact_mailcode\": null,\n \"staff_type\": null,\n \"review_qtr\": \"0\",\n \"npi\": null,\n \"name_prefix\": \"Dr.\",\n \"contact_phone_home\": \"444-444-4444\",\n \"contact_phone_cell\": \"777-777-7777\",\n \"inst_start_date\": \"2017-05-01\",\n \"inst_end_date\": null,\n \"gender\": null,\n \"rank\": null,\n \"typeid\": null,\n \"faculty_deptid\": \"0\"\n}"}],"_postman_id":"f148e826-84c9-4675-b1a4-ba4fca726273"},{"name":"users/studentUpdate","id":"2f3b7e71-970f-4223-8503-643283a54819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only
\n","key":"request","type":"text","value":"{\"userID\":\"119712\", \"fields\":[{\"username\":\"APIUpdateExample\"},{\"gender\":[{\"value\":\"M\"}]}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentUpdate","description":"Update a student account in MedHub.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.20 | \nstudent's unique MedHub ID | \n
| fields | \narray | \nYes | \nv1.20 | \nThis array will contain the fields to update in the student account paired with their update values. Use users/studentFields to get a list of all available student demographic fields. Note: fields that cannot be removed or nulled as part of this update call include all the fields that are required to create a new student account, including: institution_abbreviation, last_name, first_name, username, email_address, training_year, student_type. | \n
example only
\n","key":"request","type":"text","value":"{\"userID\":\"97927\",\"fields\":[{\"empl_id\":\"1234ABC\"},{\"email_address\":\"APItest@test.com\"}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentUpdate","description":"Update a resident account in MedHub.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
userID | integer | Yes | v1.20 | resident's unique MedHub ID |
fields | array | Yes | v1.20 | This array will contain the fields to update in the resident account paired with their update values. Use users/residentFields to get a list of all available resident demographic fields. Note: fields that cannot be removed or nulled as part of this update call include all the fields that are required to create a new resident account, including: last_name, first_name, username, email, program_abbreviation_current, pgy_level_current, program_start_date, program_end_date, trainee_type_current. |
HTTP Success or Error message will be returned.
\n","urlObject":{"path":["users","residentUpdate"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"30cb4b8d-7754-4e37-8807-0abb7a770ecd","name":"users/residentUpdate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only","key":"request","type":"text","value":"{\"userID\":\"97927\",\"fields\":[{\"empl_id\":\"1234ABC\"},{\"email_address\":\"APItest@test.com\"}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentUpdate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 May 2020 20:00:47 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"success\"\n}"}],"_postman_id":"083b5e2d-0bdb-40c0-bbe7-46288aef5d1e"},{"name":"users/facultyUpdate","id":"19850446-ad6b-478e-8eea-62ef2ead0fe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only
\n","key":"request","type":"text","value":"{\"userID\":\"77116\",\"fields\":[{\"employeeid\":\"123API\"},{\"email\":\"APItest@test.com\"}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/facultyUpdate","description":"Update a faculty account in MedHub.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.21 | \nfaculty's unique MedHub ID | \n
| fields | \narray | \nYes | \nv1.21 | \nThis array will contain the fields to update in the faculty account paired with their update values. Use users/facultyFields to get a list of all available faculty demographic fields. Note: fields that cannot be removed or nulled as part of this update call include all the fields that are required to create a new faculty account, including: last_name, first_name, username, email. | \n
example only
\n"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentCreate","description":"Creates a medical student account.
\nNote: this call does not create student training history records. These will need to be added manually through the MedHub user interface either individually or by batch action task wizard.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
| institutionID | integer | Yes | v1.20 | |
| schoolID | integer | Yes | v1.20 | |
| fields | array | Yes | v1.20 | This array will contain the fields needed to create the new student account. Use users/studentFields to get a list of all available field names. Required fields to create a new student account include:
|
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
| student userID | unique userID of the created student | integer | v1.20 |
example only
\n","key":"request","type":"text","value":"{\"institutionID\":\"1\",\"fields\":[{\"last_name\":\"Resident\"},{\"first_name\":\"APIExample\"},{\"username\":\"ResAPIEx\"},{\"email_address\":\"test@medhub.com\"}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentCreate","description":"Creates a new resident user account in MedHub.
\nNote: when assigning trainee_type the assignment must be made as an array within the fields array. For example: {\"trainee_type_current\":[{\"value\": 1}]}
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
institutionID | integer | Yes | v1.20 | |
fields | array | Yes | v1.20 | This array will contain the fields needed to create the new resident account. Use users/residentFields to get a list of all available field names. Required fields to create a new resident account include:
|
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
userID | unique user ID of the created resident | integer | v1.20 |
example only
\n","key":"request","type":"text","value":"{\"institutionID\":\"1\",\"fields\":[{\"last_name\":\"Faculty\"},{\"first_name\":\"APIExample\"},{\"username\":\"FacAPIEx\"},{\"email\":\"APIFacEx@medhub.com\"}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/facultyCreate","description":"Creates a new faculty user account in MedHub.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| institutionID | \ninteger | \nYes | \nv1.21 | \n\n |
| fields | \narray | \nYes | \nv1.21 | \nThis array will contain the fields needed to create the new faculty account. Use users/facultyFields to get a list of all available field names. Required fields to create a new faculty account include:
| \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \nunique user ID of the created faculty account | \ninteger | \nv1.21 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"programID\":890}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentsCount","description":"Lists the number of active residents in a specified program
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| programID | \ninteger | \nYes | \nv1.22 | \n\n |
Response will show the number of active residents.
\n","urlObject":{"path":["users","residentsCount"],"host":["https://{yourURL}.medhub.com/functions/api"],"query":[],"variable":[]}},"response":[{"id":"ef8becec-28c9-48fb-85d7-aa67d59571ec","name":"users/residentsCount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","type":"text","value":"{{APIclientID}}"},{"key":"ts","type":"text","value":"{{unixTimestamp}}"},{"key":"type","type":"text","value":"json"},{"description":"example only","key":"request","type":"text","value":"{\"programID\":890}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentsCount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Apr 2020 12:56:16 GMT"},{"key":"Server","value":"Apache"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/html;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"3"}],"_postman_id":"bb9c4d42-3e19-43f2-b37d-d6c5084994a8"},{"name":"users/residentEducation","event":[{"listen":"prerequest","script":{"id":"663a8b9d-7c80-4837-a8e8-026173004fb3","exec":[""],"type":"text/javascript"}}],"id":"04b69b9e-8083-4d3a-8ef4-fd0a7517ab85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"clientID","value":"{{APIclientID}}","type":"text"},{"key":"ts","value":"{{unixTimestamp}}","type":"text"},{"key":"type","value":"json","type":"text"},{"key":"request","value":"{\"userID\":97927}","type":"text","description":"example only
\n"},{"key":"verify","value":"{{verificationStringHashed}}","type":"text"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentEducation","description":"Retrieves a list of a resident's education records.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \n\n | unique user identifier | \n \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| school_name | \nname of school | \nstring | \n\n | \n |
| school_type | \ntype of school | \ninteger | \n\n | values: 1 = medical school, 2 = graduate school, 3 = undergraduate school | \n
| school_code | \n\n | integer | \n\n | \n |
| schoolID | \nunique school identifier | \ninteger | \n\n | \n |
| graduated | \nvalue for wether or not resident graduated from the school | \ninteger | \n\n | value 1 = yes (graduated), value 0 = no (not graduated) | \n
| date_attended_start | \ndate the resident started attending the school | \ndate | \n\n | format YYYY-MM-DD | \n
| date_attended_end | \ndate the resident stopped attending the school | \ndate | \n\n | format YYYY-MM-DD | \n
| school_degree | \ndegree granted to the resident | \nstring | \n\n | \n |
| school_country | \ncountry location of school | \nstring | \n\n | \n |
example only
\n","key":"request","type":"text","value":"{\"userID\":116772,\"programs\":[{\"value\":890,\"default\":true},{\"value\":467}]}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/facultyAccess","description":"Set faculty access to only the programs and courses/clerkships provided.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.21 | \n\n |
| programs | \narray | \nYes | \nv1.21 | \nArray of integers identifying the program(s) where faculty will be added. Use programs/all to get a list of all available programs | \n
| clerkships | \narray | \nYes | \nv1.21 | \nArray of integers identifying the course/clerkship(s) where faculty will be added. Use courses/all to get a list of all available courses/clerkships | \n \n
example only
\n","key":"request","type":"text","value":"{\"username\":\"Chung.Haas\",\"status\":\"inactive\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentSearch","description":"Retrieves general user information given a unique identifier (MedHub userID).
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
userID | integer | Yes | v1.02 |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
userID | unique user identifer | integer | v1.02 | |
name_last | last name of user | text | v1.02 | |
name_first | first name of user | text | v1.02 | |
email | email address | text | v1.02 | |
username | user's MedHub username | text | v1.02 | |
employeeID | user's employee ID | text | v1.02 | |
user_type | user type ID assigned in MedHub | integer | v1.02 | use users/userTypes to get a list of all user types |
user_type_name | defined user type name | text | v1.02 | |
programID | unique identifer of program | integer | v1.02 | Identifies current program of resident. Note, if user is faculty this field identifies their primary program |
program_name | name of program (description of programID) | text | 1.07 | |
courseID | unique identifier of course | integer | v1.07 | Identifies current course of student. Note, if user is faculty this field identifies their primary course |
course_name | name of course (description of courseID) | text | v1.07 | |
courses_all | all course associations | array | v1.07 | Identifies all courses a student has been associated with. Note, if user is faculty this array identifies all of their course assignments |
resident_typeID | unique identifier of resident type | integer | v1.02 | Use users/residentTypes to get all available resident types defined by the institution. This field will be left blank for all non-resident user types. |
resident_level | resident PGY level | integer | v1.02 | This value will be left blank for all non-resident user types. |
status | user status | integer | v1.02 | Values: 0 = inactive, 1 = active |
status_name | user status description | text | v1.02 | |
access | user access to system | integer | v1.02 | Values: 0 = no access, 1 = access |
access_name | user access description | text | v1.02 | |
photo_full_url | URL for full-resolution photo of user | text | v1.05 | If no photo has been uploaded for the user, this field will be blank |
photo_thumb_url | URL for thumbnail photo of user | text | v1.05 | If no photo has been uploaded for the user, this field will be blank |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/types","description":"Retrieves a list of the user types defined by for the institution.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| n/a | \n\n | \n | \n | \n |
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| type_name | \ntype of user | \nstring | \nv0.90 | \n\n |
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/residentTypes","description":"Retrieves a list of the resident types defined by the GME Office.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
n/a |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
typeID | unique identifier for resident type | int | ||
type_name | name of resident type | string | ||
visiting_flag | flags whether or not the resident type should identify assigned residents as visitors | int | Values:
|
no input required
\n","key":"request","type":"text","value":""},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/studentTypes","description":"Retrieves a list of the student types defined by the Dean's Office.
\n| Variable Name | Data Type | Required | Version | Notes |
|---|---|---|---|---|
n/a |
| Field Name | Description | Data Type | Version | Notes |
|---|---|---|---|---|
typeID | unique identifier for student type | int | ||
type_name | name of student type | string | ||
visiting_flag | flags whether or not the student type should identify assigned students as visitors | int | Values:
| |
schoolID | unique identifer for the school | int | Use schools/access to lookup existing school information |
example only
\n","key":"request","type":"text","value":"{\"userID\": \t \t85768,\"app\":\"ios_dutyhours\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/deviceToken","description":"Retrieves a user's mobile device token.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| userID | \ninteger | \nYes | \nv1.22 | \n\n |
| app | \ntext | \nYes | \nv1.22 | \nMedHub app used: values = ios_dutyhours, or android_dutyhours | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| UDID | \nunique device identifer | \ninteger | \nv1.22 | \n\n |
| token | \nunique identifer for user and device | \ninteger | \nv1.22 | \n\n |
example only
\n","key":"request","type":"text","value":"{\"username\":\"APIExample\",\"passkey\":\"eca2nmhj\"}"},{"key":"verify","type":"text","value":"{{verificationStringHashed}}"}]},"url":"https://{yourURL}.medhub.com/functions/api/users/authenticate","description":"User authentication, get a userID and user type for a given username and external passkey.
\n| Variable Name | \nData Type | \nRequired | \nVersion | \nNotes | \n
|---|---|---|---|---|
| username | \ntext | \nYes | \nv1.22 | \n\n |
| passkey | \ntext | \nYes | \nv1.22 | \nExternal passkey for given user. Note, this key is found in user preferences | \n
| Field Name | \nDescription | \nData Type | \nVersion | \nNotes | \n
|---|---|---|---|---|
| result | \n\n | \n | v1.22 | \nHTTP success or error message will be returned | \n
| userID | \nunique identifer of user | \ninteger | \nv1.22 | \n\n |
| usertype | \nunique identifer of user type | \ninteger | \nv1.22 | \nValues: 1 = resident, 2 = faculty | \n
| failure_type | \nfailure code | \ntext | \nv1.22 | \nValues:
| \n
| failure_description | \ndescription of failure code | \ntext | \nv1.22 | \n\n |