FAQ's

Are FHIR extensions supported?

We do support extensions on all FHIR resources. You can test out the conformance of any resource on each resource page, for instance the Patient DSTU2 resource or via API.

For example see this patient resource with the extension which you can paste into the validator.

{
"id": "1",
"name": [
{
"given":["Scott"]
}
],
"extension":[
{
"valueString":"abc",
"url":"http://domain.com/ext"
}
]
}

Are there any FHIR endpoints that are not yet operational?

Yes all of the FHIR endpoints are implemented. For example event the Subscription endpoint (/dev/doc/fhir-subscription) is supported.

There are some parameters or esoteric access patterns which are not currently included. If you would like support for some specific features, please email [email protected].

What data is accessible via connected health systems?

Most health systems support the following resources in the FHIR format

DSTU2 is the supported FHIR version for most systems

Medicare patients receive data for claims from which we also extract clinical information

STU3 is the supported version for Medicare

Immediately, these 4 resources will be available:

After about ~60 seconds these additional resources will also load and be available:

Do I need to use OAuth to test the 1upHealth APIs?

Yes, OAuth is required, even for testing. In order for you to get started quickly, there are a couple of options.

  • Perform the oAuth step manually once, and store the token on your machine for future tests.

  • Use a browser-less webdriver (e.g. Selenium) to go through the OAuth flow using the test credentials.

Is R4 supported?

Yes we support for all FHIR R4 Resources. This is especially important if you are a payer to meet the Cures Act interoperability mandates.

Is STU3 supported?

Yes we support for all FHIR STU3 Resources.

How do you make a FHIR Provenance query?

You can query any newly imported or created resource using a url like this with the target and the full resource url:

https://api.1up.health/fhir/dstu2/Provenance?target=Patient/${patientId}/_history/${versionId}

or for STU3

https://api.1up.health/fhir/stu3/Provenance?target=Patient/${patientId}/_history/${versionId}

How can I make changes to the data imported from EHR sources?

You can make changes to externally linked data that is pulled in via the Connect API without having my data overwritten by the source providers. Because data from source systems like EHRs and wearable devices is synced every 5 minutes or less, any updates made by your app may be overwritten by the background sync from 1upHealth. To modify or save changes to data from source systems, it’s necessary to create a new unique resource and change the data in that. The new resource you create will not be linked to the backend data sync. If there are multiple provider systems, your application logic can use data from multiple systems and apply changes to the new unique resource.

How Do I Access Demo Patient Data for FHIR Testing?

1upHealth lists demo patient records from multiple EHR vendors with data to test extracting data through the FHIR API. Here is a list of test credentials.

How long does it take to integrate 1upHealth data into my app?

You can integrate data from any of the 1upHealth supported health systems with FHIR data in just a few minutes. We have a demo application and a getting started guide to help developers start up. Because 1upHealth uses patient authorization, you do not need any prior relationship with the healths systems we support. Additionally all the data is transmitted and linked via RESTful APIs so there’s no need to understand specialized healthcare technologies. Data is all stored on 1upHealth so you do not need to stand up a HIPAA compliant database either.

How long does it take for the patient data to be populated?

Once a patient connects to a healthcare system or device via the 1upHealth connect API, the user's access token will provide access to data nearly immediately. There may be a several second delay. Ongoing, there is a process that runs in the backend to update data every 5 minutes.

Is it a mandatory step to register a credit card in order to get developer access?

No, a credit card is not required for registration. For free, you will get 1000 queries per month for development purposes. However for production access, for a number of reasons, including verification and the sensitivity of patient health data, a credit card is required.

What are the time limits on token and refresh tokens?

Access Token, refresh Token and access code expire in 7200 seconds. You get only one refresh token for an accessToken. You can get a new pair of access and refresh token anytime before 2 hour expiration period. Here is the link for that.

What is a 1upHealth User?

A user can mean many things depending on the application. A user may be a patient, provider, or even a backend service. Therefore there are separate entities for the PaitentResourceId and the OneupUserId. If it’s desirable to create separate users for each patient, that can be done through the User API. You can create users via the 1upHealth User Management API.

What is an app user id and where to get it?

An app_user_id is generated when you create a new user on 1upHealth. More information about what a 1upHealth user is and how you can create one can be found here.

What is the difference between FLAT FHIR and FHIR Bulk Data?

FLAT FHIR, FHIR Bulk Data, and Bulk FHIR are all one and the same. The official HL7 standard (that we led balloting for) is called FHIR Bulk Data. But it's synonymous with FLAT FHIR (coined by Boston Children's Hospital SMART team), and Bulk FHIR.

Here is more information on FHIR Bulk Data / FLAT FHIR / Bulk FHIR

How can we get all data associated with a patient?

This would query everything associated to an individual patient. You can also use query parameters to search for specific data associated with that patient. Here is the link for more information.

curl -X GET 'https://api.1up.health/fhir/dstu2/Patient/{patient_id}/$everything' -H "Authorization: Bearer accesstokenaccesstoken"