Using the m.Care REST API

Confidential and Proprietary

© Copyright 2024 LifeScience Technologies, LLC. All rights reserved The information contained within this document is strictly CONFIDENTIAL AND PROPRIETARY and protected by the copyright and trademark laws of the United States. This information may not be copied, reproduced, distributed, transmitted, or displayed in any form or by any means.

Overview

The API uses standard web URI requests to request data from the m.Care system.

The basics for using the API are:

Fill in the authorization header of a web request to contain your authorization keys
Format the URI of the data you are requesting
Specify the format you’d prefer for receiving the data from the server
Send a web request to the endpoint listed above
Receive the response
Parse the data you’ve received and process it as necessary

Response Formats

The API system supports 3 response formats. Specifically, the system responds back with any data requested by default using an application/json MIME type format. You may override this to application/xml or text/csv to receive data in XML or CSV format by setting the Accept header with your request. If you do not set the Accept header, the system will return data in JSON format.

A consistent envelope is used for all responses alongside response codes to indicate the status of the message and any error codes.

          {
              "data": {}, [] or null
              "statusCode": 0,
              "statusDescription": "OK"
          }

Endpoints

ADTMessage

API	Description
POST api/v{version}/laboratory/{laboratoryId}/adt	No documentation available.

AlertNotificationMethod

API	Description
GET api/v{version}/alertNotificationMethods	No documentation available.

Authentication

In order to use the API, you must have previously been assigned an account credentials to LSTMonitor and those credentials must have been given access to a laboratory/department.

The first step is to visit the API Access section on the My Profile page in LSTMonitor to obtain a Client ID, Client Secret and the Authorization Code. You'll use those credentials to request an API access token which must be passed with every request you make to the API server in the authorization header that accompanies the request.

Every request must have the authorization header filled in. If the header is not filled in with an appropriate authorization key, the API will reject the request with an appropriate 401 type server response.

The API key provides you with access to 1 or more department’s worth of data. You may access each department by specifying which department you are interested in on the requests that you make the to endpoint.

The token endpoint accepts two grant types, Code and Refresh. The Code grant type accepts the Authorization Code which is good for one use. Below is a sample request.

              GET /api/v1/token/code/{authorization_code} HTTP/1.1
              Host: clientrest.lstmonitor.com
              Authorization: Bearer {client_id:client_secret (base64 encoded)}

The Authorization Code can only be used once so you need to save the refreshToken from the response each time a token is requested in order to obtain subsequent tokens via the refresh grantType. The refreshToken request is similiar to the authorization code request.

              GET /api/v1/token/refresh/{refreshToken} HTTP/1.1
              Host: clientrest.lstmonitor.com
              Authorization: Bearer {client_id:client_secret (base64 encoded)}

Once you have an accessToken you can pass it in the Authorization header of all other requests. A request to list your laboratories for example would look like:

              GET /api/v1/laboratory HTTP/1.1
              Host: clientrest.lstmonitor.com
              Authorization: Bearer {accessToken}

API	Description
POST api/v{version}/authorize/{username}/{password}	Request the authorization code needed to obtain an access token through the token/code endpoint.
GET api/v{version}/token/{grantType}/{code}	Obtain an access token using your initial API code (grantType=code) or refresh token (grantType=refresh).

CareTeam

API	Description
GET api/v{version}/laboratory/{laboratoryId}/careTeam	No documentation available.
GET api/v{version}/laboratory/{laboratoryId}/careTeam/roles	No documentation available.
GET api/v{version}/laboratory/{laboratoryId}/careTeam/shift	No documentation available.

ClinicalDecisionSupportMessage

API	Description
POST api/v{version}/laboratory/{laboratoryId}/clinicalDecisionSupport	No documentation available.

Dashboard

API	Description
GET api/v{version}/laboratory/{laboratoryId}/dashboard	No documentation available.

Document

Endpoints for managing documents

API	Description
GET api/v{version}/laboratory/{laboratoryId}/document?FolderID={FolderID}&PostedByUserAsSubject={PostedByUserAsSubject}&Title={Title}&IncludePrivate={IncludePrivate}&MIMEType={MIMEType}&TopCount={TopCount}&GraphicsOnly={GraphicsOnly}&OnDate={OnDate}&Size={Size}	Gets a list of documents belonging to the specified Laboratory.
GET api/v{version}/laboratory/{laboratoryId}/document/{documentId}?FolderID={FolderID}&PostedByUserAsSubject={PostedByUserAsSubject}&Title={Title}&IncludePrivate={IncludePrivate}&MIMEType={MIMEType}&TopCount={TopCount}&GraphicsOnly={GraphicsOnly}&OnDate={OnDate}&Size={Size}	Get the document (including the base64 encoded contents) for the specified document identifier.

Epidemic

Endpoints for managing epidemics

API	Description
GET api/v{version}/epidemic/CareCenters	Given a person's registration info, sees if they match up with a care center
POST api/v{version}/epidemic/Register	Registers everyone in a registration package and returns results of the registration

Laboratory

Endpoints for managing Laboratories

API	Description
GET api/v{version}/laboratory?Active={Active}&CompanyName={CompanyName}&ManagerID={ManagerID}&Name={Name}&UserProfileID={UserProfileID}	Gets a list of Laboratories.
GET api/v{version}/laboratory/{id}	Gets the specified Laboratory.

LaboratoryMember

Endpoints for managing Laboratory Members

API	Description
GET api/v{version}/laboratory/{laboratoryId}/member?UserProfileID={UserProfileID}&Role={Role}&Active={Active}&FirstName={FirstName}&LastName={LastName}&LaboratoryName={LaboratoryName}	Gets a list of laboratory members.
GET api/v{version}/laboratory/{laboratoryId}/member/{userProfileID}	Gets the specified laboratory identifier.
POST api/v{version}/laboratory/{laboratoryId}/member	No documentation available.
POST api/v{version}/laboratory/{laboratoryId}/member/enroll-existing	No documentation available.
PATCH api/v{version}/laboratory/{laboratoryId}/member/{userProfileId}	No documentation available.
POST api/v{version}/laboratory/{laboratoryId}/member/{userProfileID}/activate	No documentation available.
POST api/v{version}/laboratory/{laboratoryId}/member/{userProfileID}/deactivate	No documentation available.

LaboratoryMenu

API	Description
GET api/v{version}/laboratory/{laboratoryId}/menu	No documentation available.

LaboratoryRole

API	Description
GET api/v{version}/laboratory/{laboratoryID}/roles	No documentation available.

Measurement

Endpoints for managing measurements

API	Description
GET api/v{version}/laboratory/{laboratoryId}/measurement?ObservationDate={ObservationDate}&UserProfileID={UserProfileID}&MeasurementTypeID={MeasurementTypeID}&ObservationStartDate={ObservationStartDate}&ObservationEndDate={ObservationEndDate}&subjectId={subjectId}	Gets a list of measurements belonging to the specified Laboratory/Subject.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/measurement?ObservationDate={ObservationDate}&UserProfileID={UserProfileID}&MeasurementTypeID={MeasurementTypeID}&ObservationStartDate={ObservationStartDate}&ObservationEndDate={ObservationEndDate}	Gets a list of measurements belonging to the specified Laboratory/Subject.
GET api/v{version}/laboratory/{laboratoryId}/measurement/{measurementId}?subjectId={subjectId}	Gets the measurement.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/measurement/{measurementId}	Gets the measurement.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/measurement/standards	Gets the measurement standards and goals for subject.

Medication

Endpoints for managing medications and prescriptions

API	Description
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/medication?ListType={ListType}&UserProfileID={UserProfileID}&MedicationName={MedicationName}&PatientNotes={PatientNotes}&Dose={Dose}&Frequency={Frequency}&Route={Route}&LastTaken={LastTaken}&MedicationOriginID={MedicationOriginID}&MedicationState={MedicationState}	Lists the medications and prescriptions for the specified patient.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/medication/{medicationId}	Gets the medication.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/prescription/{prescriptionId}	Gets the prescription.
POST api/v{version}/laboratory/{laboratoryId}/clear-all-medication/{MRN}	No documentation available.
POST api/v{version}/laboratory/{laboratoryId}/add-medication	No documentation available.

NationalLanguage

API	Description
GET api/v{version}/nationalLanguages	No documentation available.

Planner

API	Description
GET api/v{version}/laboratory/{laboratoryId}/planner	No documentation available.
GET api/v{version}/laboratory/{laboratoryId}/planner/roles	No documentation available.
GET api/v{version}/laboratory/{laboratoryId}/planner/shift	No documentation available.

Report

API	Description
GET api/v{version}/laboratory/{laboratoryId}/report?ReportID={ReportID}&ItemID={ItemID}	No documentation available.
POST api/v{version}/laboratory/{laboratoryId}/report/execute	No documentation available.

Role

API	Description
GET api/v{version}/roles	No documentation available.

SearchSubject

API	Description
GET api/v{version}/laboratory/{laboratoryId}/searchSubject	No documentation available.

Subject

Endpoints for managing Subjects

API	Description
GET api/v{version}/laboratory/{laboratoryId}/subject?SubjectID={SubjectID}&Mrn={Mrn}&Name={Name}	Gets a list of Subjects belonging to the specified Laboratory.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}	Gets the specified subject.
POST api/v{version}/laboratory/{laboratoryId}/subject	Insert or Update a subject record
POST api/v{version}/laboratory/{laboratoryId}/subject/enroll-with-template-and-plan	No documentation available.
POST api/Subject?msg={msg}	No documentation available.

SubjectTeam

Endpoints for managing care teams

API	Description
GET api/v{version}/laboratory/{laboratoryId}/team?UserProfileID={UserProfileID}&Role={Role}&RequestingUserProfileID={RequestingUserProfileID}&SubjectTeamRoleID={SubjectTeamRoleID}&SubjectViewStartDate={SubjectViewStartDate}&SubjectViewStopDate={SubjectViewStopDate}&SortOrder={SortOrder}&subjectId={subjectId}	Gets a list of care team members belonging to the specified Laboratory.
GET api/v{version}/laboratory/{laboratoryId}/team/{subjectId}?UserProfileID={UserProfileID}&Role={Role}&RequestingUserProfileID={RequestingUserProfileID}&SubjectTeamRoleID={SubjectTeamRoleID}&SubjectViewStartDate={SubjectViewStartDate}&SubjectViewStopDate={SubjectViewStopDate}&SortOrder={SortOrder}	Gets a list of care team members belonging to the specified Laboratory.

Survey

Endpoints for managing surveys

API	Description
GET api/v{version}/laboratory/{laboratoryId}/survey/{surveyId}	Gets a list of Surveys belonging to the specified Laboratory.
GET api/v{version}/laboratory/{laboratoryId}/survey/{surveyId}/question/{surveyQuestionId}	List the available questions for the specified survey
GET api/v{version}/laboratory/{laboratoryId}/survey/{surveyId}/answer?surveyQuestionId={surveyQuestionId}	List the available answers for the specified survey/question.
GET api/v{version}/laboratory/{laboratoryId}/survey/{surveyId}/question/{surveyQuestionId}/answer	List the available answers for the specified survey/question.
GET api/v{version}/laboratory/{laboratoryId}/survey/subdist/{surveyDistributionId}?StartDate={StartDate}&Declined={Declined}&IsNew={IsNew}&InvitationDate={InvitationDate}&Complete={Complete}&CompletionDate={CompletionDate}&ExpectedCompletionDate={ExpectedCompletionDate}&UserProfileID={UserProfileID}&Title={Title}&CompletionDateOption={CompletionDateOption}&DemoSubjectOption={DemoSubjectOption}&SurveyID={SurveyID}&subjectId={subjectId}	Gets a list of SurveyDistributionSubject belonging to the specified Laboratory/Subject.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/survey/subdist/{surveyDistributionId}?StartDate={StartDate}&Declined={Declined}&IsNew={IsNew}&InvitationDate={InvitationDate}&Complete={Complete}&CompletionDate={CompletionDate}&ExpectedCompletionDate={ExpectedCompletionDate}&UserProfileID={UserProfileID}&Title={Title}&CompletionDateOption={CompletionDateOption}&DemoSubjectOption={DemoSubjectOption}&SurveyID={SurveyID}	Gets a list of SurveyDistributionSubject belonging to the specified Laboratory/Subject.
GET api/v{version}/laboratory/{laboratoryId}/survey/subdist/{surveyDistributionId}/answer/{subjectSurveyAnswerId}?SurveyID={SurveyID}&SurveyQuestionID={SurveyQuestionID}&SelectedAnswerID={SelectedAnswerID}&AnswerText={AnswerText}&SubjectID={SubjectID}&CreationStartDate={CreationStartDate}&CreationEndDate={CreationEndDate}&DemoSubjectOption={DemoSubjectOption}	List the subject answers for the specified survey distribution.
GET api/v{version}/laboratory/{laboratoryId}/subject/{SubjectID}/survey/subdist/{surveyDistributionId}/answer/{subjectSurveyAnswerId}?SurveyID={SurveyID}&SurveyQuestionID={SurveyQuestionID}&SelectedAnswerID={SelectedAnswerID}&AnswerText={AnswerText}&CreationStartDate={CreationStartDate}&CreationEndDate={CreationEndDate}&DemoSubjectOption={DemoSubjectOption}	List the subject answers for the specified survey distribution.

SystemApplication

API	Description
GET api/v{version}/laboratory/{laboratoryId}/application	No documentation available.

Task

Endpoints for managing tasks

API	Description
GET api/v{version}/laboratory/{laboratoryId}/task?subjectId={subjectId}	Gets a list of Tasks belonging to the specified Laboratory/Subject.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/task	Gets a list of Tasks belonging to the specified Laboratory/Subject.
GET api/v{version}/laboratory/{laboratoryId}/task/{taskId}?subjectId={subjectId}	Gets the specified Task.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/task/{taskId}	Gets the specified Task.
GET api/v{version}/laboratory/{laboratoryId}/task/download?subjectId={subjectId}	No documentation available.
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/task/download	No documentation available.

TaskType

API	Description
GET api/v{version}/laboratory/{laboratoryId}/task-type	No documentation available.

Test

Test endpoint

API	Description
GET api/v{version}/test/authorization	Simple authentication test.
GET api/v{version}/test/anonymous	Simple anonymous access test.

Timeline

Endpoints for managing Users

API	Description
GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/timeline	Gets a timeline for the specified subject.

TimeZone

API	Description
GET api/v{version}/timeZones	No documentation available.

UserClass

API	Description
GET api/v{version}/laboratory/{laboratoryId}/userClass	No documentation available.

UserSubset

API	Description
GET api/v{version}/laboratory/{laboratoryId}/subset/{subsetType}	No documentation available.

.NET Example


            Imports System.Net
Imports System.IO
Imports System.Runtime.Serialization.Json
Imports System.Collections.Generic
Imports System.Linq
Imports System.Web
Imports System.Text

Public Class TestWebAPI
    Private m_WebStream As Stream
    Private m_WebResponse As String = ""
    Private m_Request As HttpWebRequest
    Private m_Response As WebResponse

    Public Function Execute(url As String, httpMethod As String, body As String, ByRef response As String) As Boolean
        Dim res As Boolean = False
        Try
            Dim authHeader As String = "Bearer " + YOUR_API_KEY

            m_Request = WebRequest.Create(url)
            m_Request.Method = httpMethod
            m_Request.Headers.Add("Authorization", authHeader)
            m_Request.Accept = "application/xml"
            m_Response = m_Request.GetResponse()

            Try
                m_WebStream = m_Response.GetResponseStream()
                Try
                    Dim webStreamReader As StreamReader = New StreamReader(m_WebStream)
                    Try
                        ' Pull in any data from the web stream reader
                        While webStreamReader.Peek >= 0
                            m_WebResponse = webStreamReader.ReadToEnd()
                        End While
 
                        ' If any data was received, all is good
                        If m_WebResponse.Trim.Length > 0 Then
                            res = True
                            response = m_WebResponse
                        End If
                    Catch ex As Exception
                        Console.WriteLine(ex.Message)
                    Finally
                        If webStreamReader IsNot Nothing Then
                            webStreamReader.Dispose()
                        End If
                    End Try
                Catch ex As Exception
                    Console.WriteLine(ex.Message)
                Finally
                    If m_WebStream IsNot Nothing Then
                        m_WebStream.Dispose()
                    End If
                End Try
            Catch ex As Exception
                Console.WriteLine(ex.Message)
            End Try
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try

        Return res
    End Function

    Public Sub TryGettingStream()
        m_WebStream = m_Response.GetResponseStream()
        Try
            Dim webStreamReader As StreamReader = New StreamReader(m_WebStream)
            Try
                ' Pull in any data from the web stream reader
                While webStreamReader.Peek >= 0
                    m_WebResponse = webStreamReader.ReadToEnd()
                End While

                Dim s As String = m_WebResponse
            Finally
                If webStreamReader IsNot Nothing Then
                    webStreamReader.Dispose()
                End If
            End Try
        Finally
            If m_WebStream IsNot Nothing Then
                m_WebStream.Dispose()
            End If
        End Try
    End Sub
End Class