Skip to content

Retrieves a FHIR R4B Observation resource.

GET
/fhir/r4b/observations/{id}
curl --request GET \
--url 'http://api.probatix.localhost/fhir/r4b/observations/example?XDEBUG_SESSION=PHPSTORM' \
--header 'X-API-TOKEN: <X-API-TOKEN>' \
--header 'accept-language: de'

Retrieves a FHIR R4B Observation resource.

id
required
string

FHIR R4B Observation identifier

accept-language
string
Allowed values: de en fr

Language for Errors and Translatable properties

Example
de
XDEBUG_SESSION
string
default: PHPSTORM

Xdebug session for debugging

Example
?XDEBUG_SESSION=PHPSTORM

FHIR R4B Observation resource

Media typeapplication/json
object
resourceType
string
default: Observation
identifier
Array<object>
object
use
string | null
/[^\s]+(\s[^\s]+)*/
codeableConcept
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
system
string | null
/\S*/
value
string | null
period
Any of:
object
start
string | null format: date-time
end
string | null format: date-time
reference
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
basedOn
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
partOf
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
status
string | null
default: final /[^\s]+(\s[^\s]+)*/
category
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
code
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
subject
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
focus
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
encounter
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
effectiveDateTime
string | null format: date-time
effectivePeriod
Any of:
object
start
string | null format: date-time
end
string | null format: date-time
effectiveTiming
object
effectiveInstant
string | null format: date-time
issued
string | null format: date-time
performer
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
valueQuantity
object
valueCodeableConcept
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
valueString
string | null
valueBoolean
boolean | null
valueInteger
integer | null
valueRange
object
valueRatio
object
valueSampledData
object
valueTime
string | null format: date-time
valueDateTime
string | null format: date-time
valuePeriod
Any of:
object
start
string | null format: date-time
end
string | null format: date-time
valueAttachment
object
valueReference
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
dataAbsentReason
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
interpretation
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
note
Array<object>
object
bodySite
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
method
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
specimen
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
device
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
referenceRange
Array<object>
object
hasMember
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
derivedFrom
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
component
Array<object>
object
text
object
contained
Array<object>
object
extension
Array<object>
object
modifierExtension
Array<object>
object
id
Any of:
integer
meta
Array<object>
object
versionId
Any of:
integer
lastUpdated
string | null format: date-time
source
string | null
/\S*/
profile
Array<string> | null
security
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
tag
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
display
string | null
userSelected
boolean | null
id
Any of:
integer
extension
Array<object>
object
implicitRules
string | null
/\S*/
language
string | null
/[^\s]+(\s[^\s]+)*/
Example
{
"resourceType": "Observation",
"identifier": [
{
"use": "2986-8",
"codeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
},
"system": "http://loinc.org",
"period": {
"start": "2025-01-09T13:48:29+01:00",
"end": "2025-01-09T13:48:29+01:00"
},
"reference": {
"type": "observations/1"
}
}
],
"basedOn": [
{
"type": "observations/1"
}
],
"partOf": [
{
"type": "observations/1"
}
],
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
},
"subject": {
"type": "observations/1"
},
"focus": [
{
"type": "observations/1"
}
],
"encounter": {
"type": "observations/1"
},
"effectiveDateTime": "2025-01-09T13:48:29+01:00",
"effectivePeriod": {
"start": "2025-01-09T13:48:29+01:00",
"end": "2025-01-09T13:48:29+01:00"
},
"performer": [
{
"type": "observations/1"
}
],
"valueCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
},
"valueTime": "12:00:00",
"valueDateTime": "2025-01-09T13:48:29+01:00",
"valuePeriod": {
"start": "2025-01-09T13:48:29+01:00",
"end": "2025-01-09T13:48:29+01:00"
},
"valueReference": {
"type": "observations/1"
},
"dataAbsentReason": {
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
},
"interpretation": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
}
],
"bodySite": {
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
},
"method": {
"coding": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
},
"specimen": {
"type": "observations/1"
},
"device": {
"type": "observations/1"
},
"hasMember": [
{
"type": "observations/1"
}
],
"derivedFrom": [
{
"type": "observations/1"
}
],
"meta": [
{
"source": "http://loinc.org",
"security": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
],
"tag": [
{
"system": "http://loinc.org",
"code": "2986-8"
}
]
}
],
"language": "de"
}

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
}

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
}

Not found

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
}