Header
All request must contains "X-ApiKey" header with ClientKey in there
ClientKey example: "0d4852a98cbf4c8csb0cdee1b6f31e95f"
| Info |
|---|
Note that you will need to get a client key specific for your company (and for specific SmartAdvocate client) once you start developing an integration |
Getting a List of Record Requests
GET request to endpoint: https://api.smartadvocate.com/sasvc/SAWebService.svc/Retrieval/MedicalRequests/Get
| Note |
|---|
This is a test endpoint. Real system endpoint will be different. It can also be different for different clients. |
You will get a list of records which are marked as "Ready to pickup" for Retrieval service.
Also you can add parameter "MarkAsRead", so you won’t need to send additional request to mark records as read.
https://api.smartadvocate.com/sasvc/SAWebService.svc/Retrieval/MedicalRequests/Get?MarkAsRead=true
| Code Block | ||
|---|---|---|
| ||
{
"id": 24634,
"saCaseNo": "1017260",
"saCaseName": "Melissa v. Doe",
"office": "New York",
"recordType": "Pharmacy Records",
"requestStatus": "ReadyToPickup",
"comments": " Response: 0",
"notesToProvider": "",
"caseType": "Auto MUN Bus",
"caseStage": "Closed",
"rushOrder": false,
"dateFrom": "2013-04-01T00:00:00",
"dateTo": "2015-03-26T00:00:00",
"allDates": false,
"orderAffidavit": false,
"patient": {
"id": 1478444,
"firstName": "Melissa",
"lastName": "Gome",
"middleName": "H",
"dateOfBirth": "2015-03-26T00:00:00",
"deceased": false,
"ssn": "535-43-4444",
"address": {
"address1": "1 Main St",
"address2": "appt 1",
"address3": "",
"city": "Townville",
"state": "NY",
"zip_code": "11050"
},
"phone": "(222) 222-2222 x123",
"email": "test@mail.com",
"gender": "F"
},
"provider": {
"id":254658
"name": "Sunegova, Iva",
"address": {
"address1": "2412 21st Avenue",
"address2": "",
"address3": "",
"city": "Astoria",
"state": "NY",
"zip_code": "11105"
},
"phone": "(718) 777-1079",
"fax": ""
},
"documents": [
{
"description": "(PDF version of) ",
"category": "Appeals",
"subCategory": "Memo of Law",
"id": 2179923,
"name": "Advise of Defendant Physical Exam Date.pdf",
"mimeType": "application/pdf"
}],
"user": {
"id": 125,
"name": "Cicali, Joseph M.",
"email": "Joseph@zzsmartadvocate.com"
},
"injury": "8/6/2014 Shoulder\nSevere Neck Pain \nMuscle Deterioration \n\nAnterior cruciate Sprain and/or Strain Magnetic resonance imaging, Open Arthrotomy and Arthroscopy Grinding/Clicking, Lateral Deviation Head, Neck & Back Pain Back Pain Ankle Arthrotomy and Arthroscopy Grinding/Clicking, Lateral Deviation Head, Neck & Back Pain Back Pain Ankle Arthrotomy and Arthroscopy Grinding/Clicking, Lateral Deviation Head, Neck & Back Pain Back Pain Ankle Arthrotomy and Arthroscopy Grinding/Clicking, Lateral Deviation Head, Neck & Back Pain Back Pain Ankle 123\n",
"incident": {
"date": "2020-03-08T12:01:00",
"state": "WY"
}
}
|
...
Getting documents from SmartAdvocate
GET request to endpoint: https://api.smartadvocate.com/sasvc/SAWebService.svc/Retrieval/Documents?DocumentID={DocumentID}&RecordID={RecordID}
You get stream of document. (base64 encoded)
...
Marking a records a read will prevent it from being returned in the next request results.
PUT request to endpoint:
https://api.smartadvocate.com/sasvc/SAWebService.svc/Retrieval/MedicalRequests/MarkRead
Request body:
| Code Block | ||
|---|---|---|
| ||
{
"RecordID":[24563, 24564]
} |
...
Get a List of Document Types
GET request to endpoint: https://api.smartadvocate.com/sasvc/SAWebService.svc/Retrieval/Documents/Type
You will get a list of Document types where you can get data for parameters SADocumentSubcategoryTypeID or DocumentType.
...
Get a List of cancelation requests
GET request to endpoint: https://api.smartadvocate.com/sasvc/SAWebService.svc/Retrieval/MedicalRequests/Cancelation/Get
You will receive a list of requests that should be canceled on the Retrieval service side.
...