Submit a reading by patient refId

The patient is patientRefId in the body, else subject.reference (Patient/<refId>).

The body is a FHIR R4 Observation: code, value[x] (any of FHIR R4's eleven) or dataAbsentReason, and a combined device sample's vitals as component[] (each code, value[x], optional dataAbsentReason). The clinical time is effectiveDateTime, effectiveInstant or effectivePeriod.start, else issued, else the server's receipt; device is {reference, display}; the first identifier's value is stored as v1's refId. Other FHIR elements (meta, extension, performer, interpretation, referenceRange, …) are accepted and ignored. v1's observedAt (it wins over effective[x]), refId, string dataAbsentReason and device.id still work. A node with dataAbsentReason and no value is judged as carrying no value, and the rules read the reason as absent. valueSampledData is judged by its latest sample and stored whole, and the rules read every sample as samples. A valueDateTime, on the reading or a component, is judged and aggregated as epoch ms (valueNumber) and listed as sent. A valueBoolean is judged as 1 or 0. A valueTime is judged as ms since midnight, a valuePeriod as its length in ms (none while open or without an offset), a valueRatio as its quotient, and each is also kept as text (valueString); a valueRange is judged as the text low..high.

History is never judged. A reading whose category has a coding the tenant names as history (its historyCategories; the default pack's: batch-data, statistics, presence-batch, derived) is stored and deduplicated like any other, answered with no alerts, and never judged nor read by the rules.

The caller must be one of the patient's submitters, admins included: a known patient it is not attached to is a 403, an unknown one a 404 with type PATIENT_NOT_FOUND.

Idempotent. A reading is named by its first identifier (system|value), else by its clinical time, code, device and refId. A resend of one stored within the last hour is a 409 DUPLICATE_READING whose data.observationId is the stored reading, and is neither stored nor evaluated again. A reading with neither an identifier nor a clinical time is not deduplicated.

Concurrent requests are batched server-side. With Prefer: respond-sync evaluation finishes first and the reply adds alertIds, alerts ([{id, code}]), resolvedAlertIds and ruleCoverage; without it mode is async and alerts are delivered by webhook.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
identifier
array of objects
identifier
string
string
category
array of objects

Its codings' codes are stored; a code the tenant names in
historyCategories makes the reading history: stored, never judged.

category
note
object

Accepted as a plain string or as FHIR's [{text, time}] Annotations, which
the mapper flattens to newline-joined text. Deliberately untyped: typing it
as a string would reject real readings ovok sends today.

code
object
required
subject
object
component
array of objects
component
device
object

id (v1) or reference (FHIR) names the device.

dataAbsentReason
object

v1's string or FHIR's CodeableConcept; untyped so that neither is refused.

string
string
string
effectivePeriod
object

Only .start and .end are read, as in v1.

string
valueQuantity
object
valueSampledData
object
string
number
boolean
string
string
valuePeriod
object
valueRange
object
valueRatio
object
valueCodeableConcept
object
Headers
string

respond-sync evaluates the readings before answering: the response reports the alerts they raised and closed, and no webhook is sent for them. Without it the readings are stored and evaluated the same way before the response, which carries no alerts: they are delivered by webhook.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json