Retrieves a Observation resource.

GET

/v1/observations/{id}

const url = 'http://api.probatix.localhost/v1/observations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?XDEBUG_SESSION=PHPSTORM';
const options = {
  method: 'GET',
  headers: {'accept-language': 'de', 'X-API-TOKEN': '<X-API-TOKEN>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://api.probatix.localhost/v1/observations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?XDEBUG_SESSION=PHPSTORM' \
  --header 'X-API-TOKEN: <X-API-TOKEN>' \
  --header 'accept-language: de'

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Observation identifier

Header Parameters

accept-language

string

Allowed values: de en fr

Language for Errors and Translatable properties

Example

de

Query Parameters

XDEBUG_SESSION

string

default: PHPSTORM

Xdebug session for debugging

Example

?XDEBUG_SESSION=PHPSTORM

Responses

200

Observation resource

object

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
null

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
null

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
null

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."
  ]
}

object

@context

One of:

string
object

string

@id

required

string

@type

required

string

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
null

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
null

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
null

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

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "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

Unauthorized

A representation of common errors.

object

@context

One of:

string
object

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
}

A representation of common errors.

object

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

Example

{
  "status": 400
}

A representation of common errors.

object

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

Example

{
  "status": 400
}

403

Forbidden

A representation of common errors.

object

@context

One of:

string
object

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
}

A representation of common errors.

object

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

Example

{
  "status": 400
}

A representation of common errors.

object

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

Example

{
  "status": 400
}

404

Not found

A representation of common errors.

object

@context

One of:

string
object

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
}

A representation of common errors.

object

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

Example

{
  "status": 400
}

A representation of common errors.

object

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

Example

{
  "status": 400
}