Skip to main content

Introduction

Overview​

The Plasma platform provides a FHIR API and other supplimentary APIs that your app can connect to in order to interact with EHRs. The API behaves like a standard FHIR API, but is able to route and normalize requests to various FHIR servers. The API should be accessed at the URL where your instance of Plasma is deployed.

For example, if your instance is deployed at https://plasma.my-app.com, then you will access the API at https://plasma.my-app.com/api.

Or, if you are using the hosted instance, you may access the API at https://plasma.smart-on-fhir.com/api.

Headers​

For some APIs, custom headers can be added to the request, which are described below:

  • x-plasma-state: This is a unique code that should be included when making requests to the Plasma FHIR API and will be used to verify requests.
    • For patient/clinician-facing apps, the state will be returned to your application via a URL parameter
    • For backend apps, the state will be returned after calling /api/plasma/sof/backend-connect
  • x-plasma-project-id:
    • For backend apps, this is the ID of the project that you want to connect to
    • For patient/clinician-facing apps, this is not needed since the app will have already been launched within the context of a project
  • x-plasma-environment-id:
    • For backend apps, this is the ID of the environment that you want to connect to
    • For patient/clinician-facing apps, this is not needed since the app will have already been launched within the context of an environment
  • x-plasma-project-secret:
    • For backend app, this is the secret provided for the project you are connecting to