Open Health Sync
Releasesv0.1.0
Api referenceEndpointsFhir

One FHIR R4 Observation

GET
/v1/users/{id}/fhir/Observation/{observation_id}

The Observation an entry's fullUrl points to. Not the user's, not an id of these forms, or not of that shape (qs- of a sample that is half of a blood pressure panel, bp- of a sample that is not) is a 404. In the merged view (the default) a daily summary carries only the figures no better ranked source of the day holds.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid
observation_id*string

The Observation id, as the Bundle gives it: qs-, bp- (the systolic sample's id), sleep-, workout-, daily-, ecg- or nutrition-, then the stored row id.

Query Parameters

view?string

merged (the default): when several sources recorded the same thing (a ring and a watch the same night, a phone and a watch the same steps, one sample directly and through an aggregator), only the best ranked source's record is listed, so nothing counts twice. The order of sources is the user's (see source-priorities). all: every stored record of every source.

Default"merged"
Value in"merged""all"

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The Observation.

application/fhir+json
  1. response

A FHIR R4 Observation made from one quantity sample, a blood pressure pair, a sleep session, a workout, a daily summary or an ECG recording (docs/fhir.md).

resourceType*string
id*string
Match^[A-Za-z0-9\-\.]{1,64}$
meta?
identifier?array<>

The provider's own id of the record (of each sample of a panel), when it has one.

status*string
category?array<>
code*
subject*
effectiveDateTime?string
Formatdate-time
effectivePeriod?
issued?string

When the record was ingested (the later of a panel's two samples).

Formatdate-time
performer?array<>

The person, on a self report (category survey); absent otherwise.

valueQuantity?
valueCodeableConcept?

Instead of valueQuantity for a classification (ecg_afib_classification).

dataAbsentReason?
device?
component?array<>

The two values of a blood pressure panel, or a sleep session's, workout's, daily summary's or ECG recording's other fields; a field without a value is left out.

Items1 <= items
curl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/fhir/Observation/qs-1234' \  -H 'Authorization: Bearer ohs_sk_...'
{  "resourceType": "Observation",  "id": "qs-1234",  "meta": {    "source": "http://example.com",    "profile": [      "http://example.com"    ],    "tag": [      {        "system": "http://example.com",        "code": "string",        "display": "string"      }    ]  },  "identifier": [    {      "system": "http://example.com",      "value": "string"    }  ],  "status": "final",  "category": [    {      "coding": [        {          "system": "http://example.com",          "code": "string",          "display": "string"        }      ],      "text": "string"    }  ],  "code": {    "coding": [      {        "system": "http://example.com",        "code": "string",        "display": "string"      }    ],    "text": "string"  },  "subject": {    "reference": "Patient/3f0c2f8e-8b8a-4c55-9f5e-2b0f3a1d9c11",    "identifier": {      "system": "http://example.com",      "value": "string"    },    "display": "string"  },  "effectiveDateTime": "2019-08-24T14:15:22Z",  "effectivePeriod": {    "start": "2019-08-24T14:15:22Z",    "end": "2019-08-24T14:15:22Z"  },  "issued": "2019-08-24T14:15:22Z",  "performer": [    {      "reference": "Patient/3f0c2f8e-8b8a-4c55-9f5e-2b0f3a1d9c11",      "identifier": {        "system": "http://example.com",        "value": "string"      },      "display": "string"    }  ],  "valueQuantity": {    "value": 0,    "unit": "string",    "system": "http://unitsofmeasure.org",    "code": "/min"  },  "valueCodeableConcept": {    "coding": [      {        "system": "http://example.com",        "code": "string",        "display": "string"      }    ],    "text": "string"  },  "dataAbsentReason": {    "coding": [      {        "system": "http://example.com",        "code": "string",        "display": "string"      }    ],    "text": "string"  },  "device": {    "reference": "Patient/3f0c2f8e-8b8a-4c55-9f5e-2b0f3a1d9c11",    "identifier": {      "system": "http://example.com",      "value": "string"    },    "display": "string"  },  "component": [    {      "code": {        "coding": [          {            "system": "http://example.com",            "code": "string",            "display": "string"          }        ],        "text": "string"      },      "valueQuantity": {        "value": 0,        "unit": "string",        "system": "http://unitsofmeasure.org",        "code": "/min"      },      "valueCodeableConcept": {        "coding": [          {            "system": "http://example.com",            "code": "string",            "display": "string"          }        ],        "text": "string"      },      "valueSampledData": {        "origin": {          "value": 0,          "unit": "string",          "system": "http://unitsofmeasure.org",          "code": "/min"        },        "period": 0,        "factor": 0,        "dimensions": 1,        "data": "string"      },      "dataAbsentReason": {        "coding": [          {            "system": "http://example.com",            "code": "string",            "display": "string"          }        ],        "text": "string"      }    }  ]}
Edit on GitHub