Cloud EHRServer (beta)

Using the EHRServer staging server

We have a small server for testing that has the same configuration as the production one, it just has less resources, so it might run a little slower but for testing that is not a problem. This guide will help you setup an account and use the staging server to test your apps before going live.

  1. Account
  2. Fundamentas
  3. Basic management

1. Account

To start testing you need an account. Go to the staging server and click on "Create an account". Fill the form and click on the Register button. Important: remember your username. You will receive an email notification with the organization number assigned by the EHRServer to your company, also remember that number!. Click on the reset password link on the email, so you can set a password for your user. Also remember the pasword!

If all the process was excecuted, you will end up with a username, password and organization number. Go to the staging server again, and use that information to login. If you can login, your account is all setup. Congratulations!

2. Fundamentals

When you register in the EHRServer a user is created for you. That user is associated with an organization, that would be your company. And the EHRServer will assign the ORGANIZATION MANAGER role to your user, so you can manage your organization. The organization and will be use to secure data access on the EHRServer. For example, all the clinical information of the patients you manage, will also be associated with your organization, so other users can't access data under your organization, unless you give them access.

You can create other organizations and associate clinical records to those organizations. We recommend to create one organization for your company (created during the user sign up) and one organization for each client you have. So if you have an app used by 3 clients, and those apps are using the EHRServer as backend, the users of each of your clients will access only clinical data associated with their correspondent organization.

Of course the users of your apps will need to be authenticated in the EHRServer to access the clinical data. There are two ways of doing this. You can manage those users directly in the EHRServer, or you can manage them on your apps and generate an API Key to authenticate your apps on the EHRServer API. To create an API Key go to Organizations > clink on one organization's name > go to the API Keys section and click on Generate > fill in the name or ID of the system that will use this API Key to access the EHRServer > click on Create. If the creating succeeded, you will see the new key created (it is a long string of characters and numbers). That will be used to access the API. Please check the EHRServer Guide to learn how to use it.

3. Basic management

Let's define the main sections of the EHRServer Web Console:

  • Dashboard: summary of the data associated with the current organization
  • EHRs: clinical records of the patients associated with the current organization
  • Contributions: audit trail of the changes for each EHR
  • Versions: versioned documents committed for each EHR associated with the current org
  • Directory: allows to define folder structures for each EHR
  • Queries: create and test queries over EHR data using the Web Query Builder
  • Templates: clinical document definitions, you can add more as you need them, should be compliant with the openEHR standard
  • Users: manage users associated with the current organization, you can create other ORGANIZATION MANAGERS or plain USERS that won't have access to the Web Console, but can login through the REST API.
  • Organizations: manage your organizations
  • Notifications: create notifications for other users under your organization, will appear when other users access certain serctions of the Web Console

To start using the EHRServer, you need to create some EHRs. No demographic data is stored in the EHRServer, so all the data is anonymized (Why?). To create an EHR an external patient id is needed, so you can link your patients (managed on an external system) with the EHRs stored in the EHRServer. Then you need to add some clinical document definitions or Templates. There will be some templates loaded for you to use, and you can add more. This article can be helpful.

After that you can create some queries to get data out the EHRServer. Go to the Queries section and create a new query. There is a video demo here, where the query creation is shown. Now the only thing you need is to commit some data. To commit data you need to use the REST API. On the EHRServer Guide there you can find the full API documentation with some examples.

Using the API you can execute the queries and get some data from the clinical documents committed to the EHRServer. This process is pretty standard and will be the same for each app that uses the EHRServer as a backend. It might be challenging when you do it for the first time, but later it will be always the same.