Getting Started
APIs
BETA - purge
We have added an endpoint to our FHIR servers for DSTU2, STU3, and R4 to delete ALL resources for a specific FHIR version under a single 1up user ID for which a client ID has authority to do so.
You can access this endpoint using either a Bearer token, or using header-based authentication.
The client ID and secret you use in the request defined below must have created the 1up user ID which you are attempting to purge data from. In other words, you can't purge the data for a 1up user that you didn't create under your own app (client ID / secret).
Further this endpoint deletes all the FHIR resources (all types) for the given 1up user for a particular FHIR version (e.g., R4). It does NOT delete the user itself which will continue to exist, just without any FHIR resources after the purge.
Purge Using Bearer Token Auth
To get an access token, please see our Auth APIs:
delete
https://api.1up.health/{fhirVersion}
/purge
Deletes all resources for given fhirVersion (dstu2, stu3, r4) for a single oneup user
Example
1
curl --location --request DELETE 'https://api.1up.health/r4/purge' \
2
--header 'client_id: xxxx' \
3
--header 'client_secret: yyy' \
4
--header 'Authorization: Bearer zzzz'
Copied!
Purge Using Header Auth
You can also use the
oneup_user_id for a given user as a header. To obtain the oneup_user_id given an app_user_id see our User Management APIs:delete
https://api.1up.health/{fhirVersion}
/purge
Deletes all resources for given fhirVersion (dstu2, stu3, r4) for a single oneup user
Example
1
curl --location --request DELETE 'https://api.1up.health/r4/purge' \
2
--header 'client_id: xxx' \
3
--header 'client_secret: yyy' \
4
--header 'x-oneup-user-id: 11111'
Copied!
Last modified 10d ago