Getting Started
APIs
FHIR Delete
With 1upHealth, you can
DELETE any FHIR resource or version from the FHIR _history endpoint.Here's how you delete a FHIR resource
To delete a single resource use the command below. It will only delete the individual resource. Past version histories will remain to help apps ensure HIPAA compliance and proper backups. Once a resource is deleted, a
GET request to the same endpoint will indicate it is no longer available with a 410 GONE status code as per the FHIR specification.1
curl -XDELETE 'https://api.1up.health/dstu2/Patient/{patientId}' \
2
-H 'Authorization: Bearer access_token'
Copied!
Deleting version history is a capability outside the FHIR specification, but is provided for customers to allow for their specific requirements. Once a resource AND its history are deleted, the information is not recoverable. Deleting a resource's version history will permanently delete the resource's version history. When the resource's version history is deleted AND the resource is deleted, then reading the resource explicitly by its id will return a
404 NOT FOUND status code as though the resource had never existedTo delete a FHIR resource's version history use the following command. Each individual version history item must be deleted explicitly using a command like this.
1
curl -XDELETE 'https://api.1up.health/dstu2/Patient/{patientId}/_history/{versionId}' \
2
-H 'Authorization: Bearer access_token'
Copied!
An example delete item's response looks like this:
1
{
2
"resourceType": "OperationOutcome",
3
"id": "qk8jk2coi",
4
"issue": [
5
{
6
"severity": "information",
7
"code": "value",
8
"details": {
9
"text": "this resource with id 3ad226c56b9b and version 9000000000002 has been deleted"
10
}
11
}
12
]
13
}
Copied!
After a resource has been deleted it will no longer be returned in search requests. For an explicit read request of the deleted resource by it's id, an OperationOutcome will be returned with status code
410, indicating that the resource has been deleted. The previous state of the resource will still be available through a versioned read of its historyExample
Below are commands and responses that show the flow of creating a patient resource and deleting the same patient resource including its history.
Create a new Patient resource:
1
curl -XPOST 'https://api.1up.health/dstu2/Patient' \
2
-H 'Authorization: Bearer access_token' \
3
-H 'Content-Type: application/json' \
4
-d '{"resourceType": "Patient"}'
Copied!
Response:
1
{
2
"resourceType":"Patient",
3
"id":"7hocu3823ze1",
4
"meta":{
5
"versionId":"9000000000000",
6
"lastUpdated":"2019-09-19T17:28:37.449Z"
7
}
8
}
Copied!
Show the newly created Patient resource:
1
curl -X GET https://api.1up.health/dstu2/Patient \
2
-H 'Authorization: Bearer access_token'
Copied!
Response:
1
{
2
"resourceType":"Bundle",
3
"type":"searchset",
4
"total":1,
5
"entry":[{
6
"fullUrl":"https://api.1up.health/dstu2/Patient/7hocu3823ze1",
7
"search":{
8
"mode":"match"
9
},
10
"resource":{
11
"resourceType":"Patient",
12
"meta":{
13
"lastUpdated":"2019-09-19T17:28:37.449Z",
14
"versionId":"9000000000000"
15
},
16
"id":"7hocu3823ze1”
17
}
18
}]
19
}
Copied!
Delete the new Patient resource:
1
curl -XDELETE 'https://api.1up.health/dstu2/Patient/7hocu3823ze1' \
2
-H 'Authorization: Bearer access_token'
Copied!
Response:
1
{
2
"id":"7hocu3823ze1"
3
}
Copied!
Show the Patient resource has been deleted:
1
curl -X GET https://api.1up.health/dstu2/Patient \
2
-H 'Authorization: Bearer access_token'
Copied!
Response:
1
{
2
"resourceType":"Bundle",
3
"type":"searchset",
4
"total":1,
5
"entry":[{
6
"fullUrl":"https://api.1up.health/dstu2/Patient/hwpvwsp7gsl",
7
"search":{
8
"mode":"match"
9
},
10
"resource":{
11
"resourceType":"OperationOutcome",
12
"id":"hwpvwsp7gsl",
13
"issue":[{
14
"severity":"information",
15
"code":"value",
16
"details":{
17
"text":"this resource with id 7hocu3823ze1 and version 9000000000001 has been deleted"
18
}
19
}]
20
}
21
}]
22
}
Copied!
Show the Patient History:
1
curl -X GET https://api.1up.health/dstu2/Patient/7hocu3823ze1/_history \
2
-H 'Authorization: Bearer access_token'
Copied!
Response:
1
{
2
"resourceType":"Bundle",
3
"type":"searchset",
4
"total":2,
5
"entry":[{
6
"fullUrl":"https://api.1up.health/dstu2/Patient/7hocu3823ze1",
7
"search":{
8
"mode":"match"
9
},
10
"resource":{
11
"resourceType":"Patient",
12
"meta":{
13
"lastUpdated":"2019-09-19T17:28:37.449Z",
14
"versionId":"9000000000000"},
15
"id":"7hocu3823ze1"
16
}
17
},{
18
"fullUrl":"https://api.1up.health/dstu2/Patient/g6ek4r0tpsj",
19
"search":{
20
"mode":"match"
21
},
22
"resource":{
23
"resourceType":"OperationOutcome",
24
"id":"g6ek4r0tpsj",
25
"issue":[{
26
"severity":"information",
27
"code":"value",
28
"details":{
29
"text":"this resource with id 7hocu3823ze1 and version 9000000000001 has been deleted"
30
}
31
}]
32
}
33
}]
34
}
Copied!
Delete the Patient History:
1
curl -XDELETE 'https://api.1up.health/dstu2/Patient/7hocu3823ze1/_history/9000000000000' \
2
-H 'Authorization: Bearer access_token'
Copied!
Response:
1
{
2
"resourceType":"OperationOutcome",
3
"id":"qxfay3b0c9fkep0z3dp4aemi",
4
"issue":[{
5
"severity":"information",
6
"code":"value",
7
"details":{
8
"text":"this resource has been deleted"
9
}
10
}]
11
}
Copied!
Show the Patient History:
1
curl -X GET https://api.1up.health/dstu2/Patient/7hocu3823ze1/_history \
2
-H 'Authorization: Bearer access_token'
Copied!
Response showing both versions have been deleted:
1
{
2
"resourceType":"Bundle",
3
"type":"searchset",
4
"total":2,
5
"entry":[{
6
"fullUrl":"https://api.1up.health/dstu2/Patient/gmdu2j0571m",
7
"search":{
8
"mode":"match"
9
},
10
"resource":{
11
"resourceType":"OperationOutcome",
12
"id":"gmdu2j0571m",
13
"issue":[{
14
"severity":"information",
15
"code":"value",
16
"details":{
17
"text":"this resource with id 7hocu3823ze1 and version 9000000000000 has been deleted"
18
}
19
}]
20
}
21
},{
22
"fullUrl":"https://api.1up.health/dstu2/Patient/ie8df27mz3",
23
"search":{
24
"mode":"match"
25
},
26
"resource":{
27
"resourceType":"OperationOutcome",
28
"id":"ie8df27mz3",
29
"issue":[{
30
"severity":"information",
31
"code":"value",
32
"details":{
33
"text":"this resource with id 7hocu3823ze1 and version 9000000000001 has been deleted"
34
}
35
}]
36
}
37
}]
38
}
Copied!
Last modified 9mo ago
Copy link