Public API
Patient Functions
Surgeon Functions
General Functions
POST Patient Procedure View
Used to get information on a patient's procedure in SurgiPrice™. Requires the LoginKey from Login.
Resource URL
https://testapi.surgiprice.com/procedure/
Input Parameters
| Parameter Name | Description | Parameter Type | Required | Example |
|---|---|---|---|---|
| LoginKey | LoginKey for Logged in Patient | 32 Characters | YES | 12345678901234567890123456789012 |
| ProcedureID | Procedure ID | Integer | YES | 2 |
Result Description
| Parameter Name | Description | Parameter Type | Example |
|---|---|---|---|
| ProcedureID | ProcedureID Returned | Integer | 2 |
| Pref_Distance | Preferred Distance | String | Under 100 miles |
| PatientChoice1 | Patient's First Choice (DoctorID) | Integer | 1 |
| PatientChoice2 | Patient's Second Choice (DoctorID) | Integer | 2 |
| RecordAdded | Timestamp of Record (in Eastern Time) | Date in String Format | 10/29/2014 4:42 pm |
| ProcedureTypeID | Procedure Type ID | Integer | 2 |
| ProcedureTypeName | Procedure Type Name | String | Percutaneous coronary angioplasty (PTCA) |
| ProcedureCategoryID | Procedure Category ID | Integer | 1 |
| ProcedureCategoryName | Procedure Category Name | String | 1 |
| Pref_DOW | Preferred Day of Week | String - space delimited preferred days | Mon Thu |
| Pref_StartingDate | Preferred Starting Date | Date as String | 10/16/2014 |
| Pref_EndingDate | Preferred Ending Date | Date as String | 10/22/2014 |
| Doctors | Assigned Doctors | Array | |
| Doctors - BidID | Bid ID | Integer | 1000 |
| Doctors - DoctorID | Assigned Doctor ID | Integer | 1000 |
| Doctors - DoctorName | Assigned Doctor Name | String | Aaron Jay Lev |
| Doctors - Status | Assigned Doctor Status | String | Completed |
| Doctors - Fee | Assigned Doctor Fee | Integer | 9000 |
| Doctors - FacilityName | The Facility Name | String | Holy Cross Hospital |
| Doctors - DoctorNotes | Notes from the Doctors | String | We provide ground transportation |
| Pref_Distance_Options | Options available for Pref_Distance | Array | [Under 100 miles,Under 5 miles,...] |
| Pref_Distance_Default | Default value for Pref_Distance | String | Under 100 miles |
| Success | If the information was retrieved from the database or not | 0 (fail) or 1 (success) | 0 |
| Message | If Success=0, this parameter contains the reason the procedure view failed. This is for feedback to the user. |
String | Invalid ProcedureID |