Application developers must register with Systemedx to obtain OAuth 2.0 client credentials used to communicate with our API endpoints (refer to our authorization page for details). Systemedx XNet API portal has 2 options for user logins.
Once logged in to the developer dashboard, Developers can view or manage existing applications shown on the dashboard or can register new applications by clicking the "Add Application" Option.
Developers will then choose the appropriate application type and fill out the required fields for that type.
The following required fields are common to most app-types:
After registration, the app will be placed in a waiting status while personel at Systemedx review the app registration.
If more information/clarification about a certain aspect or use-case of the application is required, the developer may be contacted to make sure that the product registered is the appropriate fit for the use case.
Once approved, the application will be put into a Production status.
The user portal is where user's and patients of clinics utilizing Systemedx Clinical Navigator go and manage their access to API's that they have access to. They will be able to link their individual identities from the clinic that they are associated with to the api and grant access within this portal. The user will be provided a unique code from the clinic to be able to do this.
Standalone Patient App [Public or Confidential]: A 3-Legged OAuth app that launches from outside an EHR session, typically designed for direct patient interaction.
Standalone User App [Public or Confidential]: A 3-Legged OAuth app that launches from outside an EHR session, typically designed for interaction by medical personel or other healthcare entities.
EHR Launch App [Public or Confidential]: A 3-Legged OAuth app that launches from another EHR session/portal, typically designed for interaction by healthcare entities.
Bulk Data App [Public]: A 2-Legged OAuth app that has no end user interface to be used to transmit/recieve bulk data between Systemedx XNet and another healthcare entity.
A note on Public/Confidential apps: The differentiation is based upon whether the execution environment within which the app runs enables the app to maintain the confidentiality of their client credentials.