History
All updates and mutations are stored within our database (including deletions). To query for the history of operations that have occured to resources you can use the history api. History API returns a bundle of resources that have been updated, created, or deleted.
API
Parameters Supported
| Name | Description |
|---|---|
| _count | Total number of returned resources |
| _since | Returns resources with lastUpdated greater than the provided _since value |
| _since-version | Returns resources with versionId (which for our api is a sequential value) greater than value provided |
System level
System level history encompasses all mutations that have happened on the system level
R4
- CLI
- Curl
- Typescript
iguhealth api history_system r4 _since-version=2550
curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4/_history?_since-version=2550
await client.history_system({}, R4, [{name: "_since-version", value: ["2550"]}]);
R4B
- CLI
- Curl
- Typescript
iguhealth api history_system r4b _since-version=2550
curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4b/_history?_since-version=2550
await client.history_system({}, R4B, [{name: "_since-version", value: ["2550"]}]);
Type level
Type level history encompasses all mutations that have happened at the type level: Example:
R4
- CLI
- Curl
- Typescript
iguhealth api history_type r4 $ResourceType _since-version=2550
curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4/${ResourceType}/_history?_since-version=2550
await client.history_type({}, R4, resourceType, [{name: "_since-version", value: ["2550"]}]);
R4B
- CLI
- Curl
- Typescript
iguhealth api history_type r4b $ResourceType _since-version=2550
curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4b/${ResourceType}/_history?_since-version=2550
await client.history_type({}, R4B, resourceType, [{name: "_since-version", value: ["2550"]}]);
Instance level
Instance level history encompasses all mutations that have happened to a single resource: Example:
R4
- CLI
- Curl
- Typescript
iguhealth api history_instance r4 $ResourceType $ResourceId _since-version=2550
curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4/${ResourceType}/${ResourceId}/_history?_since-version=2550
await client.history_instance({}, R4, resourceType, id, [{name: "_since-version", value: ["2550"]}]);
R4B
- CLI
- Curl
- Typescript
iguhealth api history_instance r4b $ResourceType $ResourceId _since-version=2550
curl --request GET --header "Authorization: Header" --header "Content-Type: application/fhir+json" ${domain}/w/${tenant}/api/v1/fhir/r4b/${ResourceType}/${ResourceId}/_history?_since-version=2550
await client.history_instance({}, R4B, resourceType, id, [{name: "_since-version", value: ["2550"]}]);