Skip to main content

Add Projects

Under the hood,Studio needs the EHR server in order to get, use, and store forms, templates, views, and compositions. Therefore, you need to have at least one project with mandatory EHR server connection added. Studio allows adding an unlimited number of projects, and you can switch between them at anytime.

To add a project, go to the Administration module, select Projects from the menu on the left side. Pressing the Add project button next to the search bar will open the Add Project screen.

Adding a new project
warning
Make sure that the EHR Server username you are adding has a sufficient roles/permissions to access the resources on the EHR Platform. To access the Form Builder the user has to have the FORM_ADMIN or ADMIN role. If you are not sure, check the roles sections in EHR Platform Admin console or contact your EHR Platform administrator.

EHR Server Authorization Type​

You can set your project's EHR Server Authorization Type to:

  • Basic: requires a username and password
  • OAuth: requires additional parameter authorization server URL, grant type, and client ID. If the grant type is client_secret, you need to provide a client secret.
warning
The username and password for the EHR server are not the same as the username and password for the Studio.

EHR Server and Resource Server URLs​

When adding a project, you need to provide the EHR Server URL. You can optionally provide the Resource Server URL if your environment has a resource server installed and configured.

The EHR Server is where Studio will store and fetch templates, views, and compositions.

The Resource Server is where Studio will fetch resources like forms, Global APIs, Global Variables, images, and other files.

NOTE If your environment has a separate server for resources, you can provide the Resource Server URL. If you don't provide the Resource Server URL, the Studio will use the EHR Server URL for fetching resources.

Terminology Adapter URL​

You can provide the Terminology URL by setting the test value of the external variable called terminologyUrl in Administration > External variables.

warning
Setting the Terminology adapter URL has been deprecated since Studio version 3.8. Previously added Terminology adapter URLs have been migrated to the terminologyUrl variable. All existing APIs using the Terminology adapter url are backwards compatible.

Bypass Server​

The Bypass server option is enabled by default and it's recommended to keep it enabled. If you disable it, you can add a domain where all requests will be routed through the Studio backend server. This is only useful if your Better EHR platform does not have a proper CORS configuration.

EHR Server Validation​

When adding a project, Studio will always validate the EHR server. If the validation process fails, you can see the reasons for failing above the Add Project button.

A validation can fail for various reasons:

  • invalid username / password combination
  • provided EHR server version is not sufficient (only platform versions 3.0.23 and later are supported)
  • EHR Server rest API or admin rest API are not exposed on the EHR server
  • one or both URLs are not reachable
info
In case of validation failure, we suggest you to contact your EHR server administrator for assistance.