Releasesv0.1.0
Api referenceEndpointsFhir

The Provenance of one Observation

GET
/v1/users/{id}/fhir/Provenance

A searchset Bundle holding the Provenance of the Observation target names, or no entry when the user has no such Observation.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid

Query Parameters

target*string

Observation/ and an Observation id. One value.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The Provenance, or an empty Bundle.

application/fhir+json
  1. response

A FHIR R4 searchset Bundle of Provenance.

resourceType*string
type*string
link*array<>
entry?array<>

Absent when there is none.

curl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/fhir/Provenance?target=Observation%2Fqs-1234' \  -H 'Authorization: Bearer ohs_sk_...'
{  "resourceType": "Bundle",  "type": "searchset",  "link": [    {      "relation": "self",      "url": "http://example.com"    }  ],  "entry": [    {      "fullUrl": "http://example.com",      "resource": {        "resourceType": "Provenance",        "id": "prov-qs-1234",        "target": [          {            "reference": "Patient/3f0c2f8e-8b8a-4c55-9f5e-2b0f3a1d9c11",            "identifier": {              "system": "http://example.com",              "value": "string"            },            "display": "string"          }        ],        "recorded": "2019-08-24T14:15:22Z",        "agent": [          {            "type": {              "coding": [                {                  "system": "http://example.com",                  "code": "string",                  "display": "string"                }              ],              "text": "string"            },            "who": {              "reference": "Patient/3f0c2f8e-8b8a-4c55-9f5e-2b0f3a1d9c11",              "identifier": {                "system": "http://example.com",                "value": "string"              },              "display": "string"            }          }        ],        "entity": [          {            "role": "derivation",            "what": {              "reference": "Patient/3f0c2f8e-8b8a-4c55-9f5e-2b0f3a1d9c11",              "identifier": {                "system": "http://example.com",                "value": "string"              },              "display": "string"            }          }        ]      },      "search": {        "mode": "match"      }    }  ]}
Edit on GitHub