Home

TriMed’s Patient Data API offers the ability to securely access patient data stored in the TriMed EHR for a specific patient. The API requires each developer to work with the practice(s) leveraging the TriMed EHR to obtain access. See Authentication section for details. All developers must agree to the Terms and Conditions listed on this site.

Once Authentication details have been obtained, developers may call the TriMed Patient Data API using normal web methods. Outlined below is the standard order of operations in order to navigate the API:

1. Lookup Patient:

A developer invokes the LookupPatientID method in order to determine the presence of the patient in the TriMed EHR for the practice. If a matching patient is found, a unique LookupPatientID will be returned. This represents the unique patient identifier used in all the other API methods.

2. Get Patient Data:

Using the unique patient identifier obtained in step 1, the developer now invokes a method to retrieve the patient data represented by the unique patient identifier. The Get Patient Data method returns all the patient data available for a patient in a single response. All other methods are subsets of the Get Patient Data method designed to only return a specific piece of the identified patient’s records.

Developer workflow

TriMed’s Patient Data API exists as a web based API written in SOAP format. For more about SOAP format, see here. No special software is necessary to access the public facing web methods available in the TriMed Patient Data API. Example screenshots are offered below using the basic Postman tool (to download Postman click here).

TriMed’s Patient Data API is available at:

Step 1: Forming the Lookup PatientID Method.

Note: The below examples assume the developer has obtained an authentication code from the practice. Authentication codes can be generated by the practice within the TriMed EHR.

Here is an example REQUEST method for the LookupPatientID method as shown in Postman:

1. The Patient API URL is placed in the URL area and the ‘POST’ verb is chosen

2. The XML method goes in the Body

a. The method name should open the XML body: <LookupPatientId xmlns="http://tempuri.org/">
b. The Authentication Key should be placed in the sAuthKey parameter
c. The Practice Enterprise should be placed in the lEnterpriseID parameter
d. The Practice Company should be placed in the lCompanyID parameter
e. The Patient Information should be passed in the respoective Patient parameters
f. The method name should close the XML body:</LookupPatientId>


3. Send the Request to the URL using the Send button


Here is an example RESPONSE method for the LookupPatientID method as shown in Postman:

Step 2: Forming the Patient Data Method


Note: The below examples assume the developer has successfully retrieved a PatientID using the LookupPatientID method. The PatientID will be passed into the GetPatientData method.

Here is an example REQUEST method for the GetPatientData method as shown in Postman:

1. The Patient API URL is placed in the URL area and the ‘POST’ verb is chosen.

2. The XML method goes in the Body

a. The method name should be open the XML body: <GetPatientData xmlns="http://tempuri.org/">
b. The Authentication key should be placed in the sAuthKey parameter.
c. The Practice Enterprise should be placed in the lEnterpriseID parameter
d. The Practice Company should be placed in the lCompanyID parameter
e. The PatientID should be passed in the lPatientID parameter
f. Your application name should be passed in the SRequestFrom parameter
g. For each of the data types, pass a ‘true’ or ‘false’ to return that data type in the respective boolean parameters (e.g., passing ‘true’ into the SPatientName parameter will return the patient name in the response).
h. Pass the number of days from the current date into the lRelativeDays parameter to restrict the data returned by the respective number of days.
i. The method name should close the XML body: </GetPatientData>

3. Send the Request to the URL using the Send button.

For further details on forming the XML Body, see the Patient Data page.

Here is an example RESPONSE method for the GetPatientData method as shown in Postman:

Step 3: Forming Other Patient Data Methods


Note: The below examples assume the developer has successfully retrieved a PatientID using the LookupPatientID method. The PatientID will be passed into the GetPatientAllergy method.

Here is an example REQUEST method for the GetPatientAllergy method as shown in Postman:

1. The Patient API URL is placed in the URL area and the ‘POST’ verb is chosen.

2. The XML method goes in the Body

a. The method name should be open the XML body: <GetPatientAllergy xmlns="http://tempuri.org/">
b. The Authentication key should be placed in the sAuthKey parameter.
c. The Practice Enterprise should be placed in the lEnterpriseID parameter
d. The Practice Company should be placed in the lCompanyID parameter
e. The PatientID should be passed in the lPatientID parameter
f. Your application name should be passed in the SRequestFrom parameter
g. The method name should close the XML body: </GetPatientAllergy>

3. Send the Request to the URL using the Send button.

For further details on forming the XML Body, see the Patient Allergy page.

Here is an example RESPONSE method for the GetPatientAllergy method as shown in Postman: