Open Health Sync
Releasesv0.1.0
Api referenceEndpointsFhir

One FHIR R4 Provenance

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

The Provenance of one Observation; an Observation that does not exist is a 404.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid
provenance_id*string

prov- and the id of the Observation it is about.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The Provenance.

application/fhir+json
  1. response

Who and what produced one Observation, as a FHIR R4 Provenance (docs/fhir.md).

resourceType*string
id*string
Match^prov-[A-Za-z0-9\-\.]{1,59}$
target*array<>
Items1 <= items
recorded*string

When the record was ingested.

Formatdate-time
agent*array<>

The Device (author) when the record names one, then the provider (assembler).

Items1 <= items
entity?array<>

The provider's own record (each external id), when it has one.

curl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/fhir/Provenance/prov-qs-1234' \  -H 'Authorization: Bearer ohs_sk_...'
{  "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"      }    }  ]}
Edit on GitHub