Skip to content
Probatix API Documentation

Retrieves the collection of Observation resources.

GET
/v1/observations
curl --request GET \
  --url 'http://api.probatix.localhost/v1/observations?page=1&sort%5Bid%5D=asc&sort%5Bloinc%5D=asc&XDEBUG_SESSION=PHPSTORM' \
  --header 'X-API-TOKEN: <X-API-TOKEN>' \
  --header 'accept-language: de'

Retrieves the collection of Observation resources.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
accept-language
string
Allowed values: de en fr

Language for Errors and Translatable properties

Example
de

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1

The collection page number

createdAt[gt]
string

Return resources with createdAt greater than the given timestamp.

createdAt[gte]
string

Return resources with createdAt greater than or equal to the given timestamp.

createdAt[lt]
string

Return resources with createdAt less than the given timestamp.

createdAt[lte]
string

Return resources with createdAt less than or equal to the given timestamp.

exists[interpretation]
boolean

Filter by whether the interpretation exists.

exists[unit]
boolean

Filter by whether the unit exists.

observation[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

sort[id]
string
Allowed values: asc desc ASC DESC

Observation sort[id]

sort[loinc]
string
Allowed values: asc desc ASC DESC

Observation sort[loinc]

testResult[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

XDEBUG_SESSION
string
default: PHPSTORM

Xdebug session for debugging

Example
?XDEBUG_SESSION=PHPSTORM

Responses

Section titled “Responses”

200

Section titled “200”

Observation collection

Array<object>
object
id
required
string format: uuid
testResult
required

IRI of the parent test result.

string format: iri-reference
loincNum
required

LOINC code of the reported analyte.

string
value
required

Raw value as reported by the laboratory. The API exposes it as a string to preserve the original representation. Clients should not assume the value is always safely parseable as a number.

string
unit

Measurement unit when the laboratory provides one.

string | null
referenceRange
Any of:
object
intervals
required

Reference intervals for the observation. Each interval may define a lower and/or upper boundary and can optionally provide a human-readable label such as negative or positive.

Array<object>
object
label
required

Optional human-readable label for the interval, for example negative or positive.

string
lower
Any of:
object
operator
required

Comparison operator for the boundary. Lower boundaries use > or >=; upper boundaries use < or <=.

string
Allowed values: > >= < <=
value

Boundary value used together with the operator.

number | null
upper
Any of:
object
operator
required

Comparison operator for the boundary. Lower boundaries use > or >=; upper boundaries use < or <=.

string
Allowed values: > >= < <=
value

Boundary value used together with the operator.

number | null
interpretation

Laboratory interpretation, for example positive or negative.

string | null
labNotes

Free-text notes supplied alongside the observation.

Array<string> | null
createdAt
required

Timestamp when the observation was created.

string format: date-time
Example
[
  {
    "testResult": "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff",
    "loincNum": "2570-0",
    "value": "5.5",
    "unit": "µg/g",
    "referenceRange": {
      "intervals": [
        {
          "label": "negative",
          "lower": null,
          "upper": {
            "operator": "<=",
            "value": 5.5
          }
        },
        {
          "label": "positive",
          "lower": {
            "operator": ">",
            "value": 5.5
          },
          "upper": null
        }
      ]
    },
    "interpretation": "negative",
    "labNotes": [
      "Kein Hinweis auf okkultes Blut im Stuhl."
    ]
  }
]

401

Section titled “401”

Unauthorized

A representation of common errors.

object
@context
One of:
string
@id
required
string
@type
required
string
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string
description
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}

403

Section titled “403”

Forbidden

A representation of common errors.

object
@context
One of:
string
@id
required
string
@type
required
string
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string
description
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}