smartcare api - streamline healthcare solutions, llc510 east butler court, kalamazoo east, mi 49007,...
TRANSCRIPT
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
SmartCare API
Documentation version 1.0
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Table of Contents
I. Overview ............................................................................................................. 3
II. List of APIs ........................................................................................................... 4
Account ............................................................................................................................................ 4
POST /api/Account/ValidateSmartKey ............................................................................................................ 4
Briefcase ........................................................................................................................................... 4
GET /api/Briefcase/ClientBalance ................................................................................................................... 4
Calendar Event ................................................................................................................................. 5
POST /api/calendarevent/CancelAppointment ............................................................................................... 5
GET /api/calendarevent/GetCancelReasons ................................................................................................... 5
GET /api/calendarevent/GetAppointmentDetails........................................................................................... 6
Client ................................................................................................................................................ 6
GET /api/Client/ClientBalance ......................................................................................................................... 6
POST /api/Client/UpdatePayment .................................................................................................................. 7
Common ........................................................................................................................................... 7
GET /api/Common/GetGlobalCodes ............................................................................................................... 7
GET /api/Common/GetLocations .................................................................................................................... 8
GET /api/Common/GetApiDetails ................................................................................................................... 8
Patient .............................................................................................................................................. 9
GET /api/Patient/Id ......................................................................................................................................... 9
GET /api/Patient/Details ................................................................................................................................. 9
GET /api/Patient/SummaryOfCareCCDXML .................................................................................................. 10
GET /api/Patient/DemographicDetails .......................................................................................................... 10
GET /api/Patient/Allergies............................................................................................................................. 11
GET /api/Patient/CurrentMedications .......................................................................................................... 12
GET /api/Patient/ActiveProblems ................................................................................................................. 13
GET /api/Patient/HistoryOfEncounters ......................................................................................................... 14
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/Immunizations .................................................................................................................. 15
GET /api/Patient/SocialHistory ..................................................................................................................... 16
GET /api/Patient/VitalSigns ........................................................................................................................... 17
GET /api/Patient/PlanOfTreatment .............................................................................................................. 18
GET /api/Patient/Goals ................................................................................................................................. 19
GET /api/Patient/HistoryOfProcedures ......................................................................................................... 20
GET /api/Patient/StudiesSummary ............................................................................................................... 21
GET /api/Patient/LaboratoryTests ................................................................................................................ 22
GET /api/Patient/CareTeamMembers .......................................................................................................... 23
GET /api/Patient/UniqueDeviceIdentifier ..................................................................................................... 24
GET /api/Patient/HealthConcerns ................................................................................................................. 25
III. How to install Soap UI ....................................................................................... 26
Steps ............................................................................................................................................... 26
IV. Set up SmartCare API in SoapUI® ....................................................................... 32
Setup Token Generation ................................................................................................................ 33
V. Errors and Informational messages .................................................................... 37
VI. Code Example in C# ........................................................................................... 38
Authenticate and generate Token ................................................................................................. 38
Get Patients/Clients ....................................................................................................................... 39
Generate CCD/Summary of Care ................................................................................................... 40
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Overview
The purpose of SmartCare API is to allow developers to integrate and develop with SmartCare
EHR software. Developers can use these APIs to discretely exchange data between the EHR
systems and third-party applications, allowing information to be shared quickly and accurately
between healthcare providers.
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
List of APIs
Account
POST /api/Account/ValidateSmartKey
Briefcase
GET /api/Briefcase/ClientBalance
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Calendar Event
POST /api/calendarevent/CancelAppointment
GET /api/calendarevent/GetCancelReasons
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/calendarevent/GetAppointmentDetails
Client
GET /api/Client/ClientBalance
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
POST /api/Client/UpdatePayment
Common
GET /api/Common/GetGlobalCodes
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Common/GetLocations
GET /api/Common/GetApiDetails
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Patient
GET /api/Patient/Id
GET /api/Patient/Details
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/SummaryOfCareCCDXML
GET /api/Patient/DemographicDetails
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/Allergies
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/CurrentMedications
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/ActiveProblems
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/HistoryOfEncounters
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/Immunizations
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/SocialHistory
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/VitalSigns
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/PlanOfTreatment
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/Goals
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/HistoryOfProcedures
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/StudiesSummary
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/LaboratoryTests
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/CareTeamMembers
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/UniqueDeviceIdentifier
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
GET /api/Patient/HealthConcerns
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
How to install Soap UI
Steps
1. Go to https://www.soapui.org/downloads/soapui.html 2. Download the installer as indicated below
3. Save file and double click on the exe to install the SoapUI application
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Set up SmartCare API in SoapUI®
1. Download the attached SoapUI project config file(SmartApi-soapui-project.xml)
SmartApi-soapui-pr
oject.xml
2. Import the config file to SoapUI as below and say OPEN
This imports all the configurations to SoapUI.
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Setup Token Generation
1. Change your domain Url by changing the Name property
2. Double Click on the request under Token method which is highlighted in above image
(Request 1).
3. Update the Endpoint, Username and password for generating the Bearer Token as
below
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
4. After all the configuration click on the Green PLAY button for generating the Bearer
Token that can be seen in the response section below
5. Use this access_token generated in the previous step for making the other requests.
6. New config file is attached here
SmartCare-Api-soap
ui-project.xml
7. Snapshot of the functionalities are below.
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Access Token – For generating the Bearer Token. For all the request below should be
send with a valid bearer token as mentioned in Step 5
Breifcase – Get all the Breifcase data which are pulling as part of Breifcase checkout
based on the StaffId provided.
CaseLoad – Get only caseload data based on the StaffId provided.
MyPreference – Get My Preference data based on the StaffId provided.
Events – Get all Service and Non-service appointments
Config – Returns all the configurations from ConfigurationKeys which has module
column marked as ‘Mobile’
GetCancelReason- For Cancelling an appointment we need cancel reason which is a
globalCodeId with Category ‘CancelReason’. This method returns all the cancel reasons.
CancelAppointment – Cancel the appointment using by providing AppointmentId and a
Cancel Reason which is returned in the above step
GetAppointment – Get Specific appointment based on the AppointmentId.
DeleteAppointment – Deletes the existing appointment using AppointmentId and
DeletedBy username.
CalenderEvent – Which creates a new appointment in the system by providing the
appointment json array and StaffId
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Bearer token should be provided in the access_token section mentioned in above
screenshot to authorize all the api requests.
{
"clientId": 72518,
"userId": "Pradeep",
"dateReceived": "07/07/2017",
"nameIfNotClient": "TestPrd",
"paymentMethod": 4362, //PAYMENTMETHOD
"referenceNumber": "12345",
"cardNumber": "43211234",
"expirationDate": "1211",
"amount": 1000,
"locationId": 45383,//Locations
"paymentSource": 4381, //PAYMENTSOURCE
"comment": "Test Cimment",
"serviceId": 495962,
"typeofPosting": 8712, //TYPEOFPOSTING
"copayAmounts": ""
}
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Errors and Informational messages
The common errors and informational messages that can be returned by the API are listed
below:
If successful, the API will return a 200 HTTP Status Code. If the request was not successful, the
following errors may be returned:
HTTP Status code Cause 400 This error occurs when the API request is made with unsupported
parameters
403 This error occurs when the API request is made without a valid OAuth token
404 This error occurs when the API request is made with an invalid URL
500 This error occurs when the API request has failed
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Code Example in C#
Authenticate and generate Token
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Get Patients/Clients
510 EAST BUTLER COURT, KALAMAZOO EAST, MI 49007, USA
WWW.STREAMLINEHEALTHCARE.COM
Generate CCD/Summary of Care