TriMed Complete FHIR API Documentation

TriMed Complete FHIR API Documentation

Overview

The TriMed Complete FHIR API is a Rest API conforming to the R4 specification and the US Core 3.1 Implementation Guide (IG).

Terms of Use

Click here to see TRIMED EHR FHIR API Terms of Use.

Prerequisite

To begin using the TriMed Complete FHIR API, enable the option flag ‘Enable TriMed Complete FHIR’ in Admin > Global Settings.

Authentication

TriMed Complete uses OAuth to authenticate the end client according to the HL7 SMART-On-FHIR Implementation Guide.

FHIR API Documentation

The API is documented using Swagger. Access the documentation and response examples:

Sample Error Responses

Error: 400
Invalid Request — wrong data sent to the API

Error: 403
Unauthorized Access — invalid authorization header

Error: 500
Underlying service fault

Capability Statement

GET fhir/metadata
https://fhir.trimed.cloud/metadata

This will return the Capability Statement as a JSON response.

Service Based URL

The main service base endpoint is: https://fhir.trimed.cloud

Well Defined Configuration

GET fhir/metadata
https://fhir.trimed.cloud/.well-known/smart-configuration

Returns a well-defined configuration in JSON format.

3rd Party SMART Apps

TriMed Complete supports SMART on FHIR App Launch Implementation Guide 1.1.0 context. Confidential apps must be authorized by the practice.

  • Access tokens valid for 1 hour
  • Refresh tokens valid for 3 months
  • Refresh tokens only issued with offline_access scope
  • Patient must have API credentials generated from their chart by an EHR user

Native Applications

Requirements for native apps using the TriMed Complete FHIR API:

  • Store refresh token securely
  • Register app as a confidential app
  • Request offline_scope to receive a refresh token
  • Tokens valid for 3 months
  • Use only TLS-secured channels
  • Use Authorization Code grant flow

Revoking Clients, Users, Tokens

The practice can revoke access and tokens from within the patient's chart in TriMed Complete EHR.