Export Population Data

For Health Plan Partners

1upHealth customers, such as health plans, can allow their authorized health plan partners (such as providers or analytics vendors) to get access to their health plan’s data on the 1up FHIR Server. The partners that the health plan authorizes can then use 1up Exchange to export data at the population level, for a specified client ID or a group.

Before You Begin

Before you start the process to get access to the 1upHealth FHIR Server and export population-level data, make sure that you get the following information from your 1upHealth Customer Success Manager.

• Base URL

  The is the unique web address that you use to connect to the 1upHealth FHIR Server to export data.

  The base URL has this format: https://gateway.1up.health/v1/<customer-name>/

• Client credentials

  The client ID and client secret that you use to get your access token.

Get Access to the 1upHealth FHIR Server

As a partner of a 1upHealth customer (a health plan), you can get a client ID and client secret (client credentials) from your health plan partner to get access to the 1up FHIR Server and export data at the population level. After you have your client credentials, you can request the access token that you’ll use to export data from the FHIR Server.

You can use Postman to test the following REST API requests before you integrate them into your application.

To get your access token, include your client credentials in the request that you submit to the OAuth 2.0 server.

Get Your Access Token

To get your access token, submit the following request.

Make sure to replace the placeholder text with the correct customer name, client ID, and client secret.

1
2
3
4
5
curl --location 'https://gateway.1up.health/auth/realms/<customer-name>/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=yyy' \
--data-urlencode 'client_secret=xxx' \
--data-urlencode 'grant_type=client_credentials'

The request response includes your access token (Bearer token) and the scopes you can get access to with the token.

Example response

1
2
3
4
5
6
7
8
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJibGIwMjB3Y09zeWFza01rNnNJYmNPb3U1NnhYNTRvUFpEY0hVWG9XanZvIn0.eyJleHAiOjE3MTMzODk5NzksImlhdCI6MTcxMzM4NjM3OSwianRpIjoiZmFlZDJjMTYtMTc4ZS00ZWU5LTg0OGYtZTViMjljNmYwYzNhIiwiaXNzIjoiaHR0cHM6Ly9nYXRld2F5LjF1cGhlYWx0aGRldjIuY29tL2F1dGgvcmVhbG1zLzF1cGhlYWx0aGRldjIiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZWYyODBjN2UtMmJiZi00NWVjLThmZDEtMWY4NDcxMGEyMjZiIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiZ2Y2NC1vc2YzN3MtODIza2RhIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyJodHRwOi8vbG9jYWxob3N0OjgwMDAiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiZGVmYXVsdC1yb2xlcy0xdXBoZWFsdGhkZXYyIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6ImVtYWlsIHI0fHVzZXIvKi5ycyBwcm9maWxlIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJjbGllbnRIb3N0IjoiNDQuMjM3LjI0OS4yMDQiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtZ2Y2NC1vc2YzN3MtODIza2RhIiwiY2xpZW50QWRkcmVzcyI6IjQ0LjIzNy4yNDkuMjA0IiwiY2xpZW50X2lkIjoiZ2Y2NC1vc2YzN3MtODIza2RhIn0.FCWvw7SDNi9ZpEeP8pSADEj1_0F_DlS5uQ_IkI9ci1QvruSTD53e2V2J7jk39kxAX67e2JhDPzaa77Qxk3veOyf9T39yBp9EbRIUukwGUD7CatPqDswxkF6L_3peehnZj4De2KGRlK4a5wV5uZvnmAo_WMeZJlc2UheZqPqj0v3kfdhBeNCgjQGYeLNsQDSEh86QJv8lyU0EFwGlNr3aJNptuXq73LjqLgNhSUA30aT4me6YQj1iNStgzGZmMk9UPiHJo-GGK_SZmFibCJ5LYrwhyds511citfmBcNuITaVjrNxAbaIFw83D3ZLS9UJ1hPrJrs7Wp6knzTG9Uy8OmA",
    "expires_in": 3600,
    "refresh_expires_in": 0,
    "token_type": "Bearer",
    "not-before-policy": 0,
    "scope": "email r4|user/*.rs profile"
}

In this example, the scope includes r4|user/*.rs, which means that you can read data for all resource types.

Use this access token in your export request to the 1up FHIR Server endpoint.

Export Data

After you get your access token, you can use it to export population-level data for a client ID or for a group.