Skip to content
Probatix API Documentation

Creates a FHIR R4B ServiceRequest resource.

POST
/fhir/r4b/service_requests
curl --request POST \
  --url 'http://api.probatix.localhost/fhir/r4b/service_requests?XDEBUG_SESSION=PHPSTORM' \
  --header 'Content-Type: application/json' \
  --header 'X-API-TOKEN: <X-API-TOKEN>' \
  --header 'accept-language: de' \
  --data '{ "resourceType": "ServiceRequest", "identifier": [ { "use": "2986-8", "codeableConcept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" }, "system": "http://loinc.org", "value": "example", "period": { "start": "2025-01-09T13:48:29+01:00", "end": "2025-01-09T13:48:29+01:00" }, "reference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] } ], "instantiatesCanonical": [ "example" ], "instantiatesUri": [ "example" ], "basedOn": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "replaces": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "requisition": { "use": "2986-8", "codeableConcept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" }, "system": "http://loinc.org", "value": "example", "period": { "start": "2025-01-09T13:48:29+01:00", "end": "2025-01-09T13:48:29+01:00" }, "reference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] }, "status": "draft", "intent": "proposal", "category": [ { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" } ], "priority": "asap", "doNotPerform": false, "code": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" }, "orderDetail": [ { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" } ], "quantityQuantity": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "quantityRatio": { "numerator": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "denominator": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] }, "quantityRange": { "low": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "high": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] }, "subject": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "encounter": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "occurrenceDateTime": "2025-01-09T13:48:29+01:00", "occurrencePeriod": { "start": "2025-01-09T13:48:29+01:00", "end": "2025-01-09T13:48:29+01:00" }, "occurrenceTiming": { "event": "2025-01-09T13:48:29+01:00", "repeat": { "boundsDuration": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "boundsRange": { "low": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "high": { "value": 1, "comparator": "=", "unit": "example", "system": "http://loinc.org", "code": "ABC", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] }, "boundsPeriod": { "start": "2025-01-09T13:48:29+01:00", "end": "2025-01-09T13:48:29+01:00" }, "count": 1, "countMax": 1, "duration": 1, "durationMax": 1, "durationUnit": "min", "frequency": 1, "frequencyMax": 1, "period": 1, "periodMax": 1, "periodUnit": "min", "dayOfWeek": "mon", "timeOfDay": "12:00:00", "when": "HS", "offset": 1 }, "code": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" }, "id": 1, "extension": [ {} ] }, "asNeededBoolean": true, "asNeededCodeableConcept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" }, "authoredOn": "2025-01-09T13:48:29+01:00", "requester": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "performerType": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" }, "performer": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "locationCode": [ { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" } ], "locationReference": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "reasonCode": [ { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" } ], "reasonReference": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "insurance": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "supportingInfo": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "specimen": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "bodySite": [ { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "text": "example" } ], "note": [ { "authorReference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "authorString": "example", "time": "2025-01-09T13:48:29+01:00", "text": "# README", "id": 1, "extension": [ {} ] } ], "patientInstruction": "Text", "relevantHistory": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "text": {}, "contained": [ {} ], "extension": [ {} ], "modifierExtension": [ {} ], "id": 1, "meta": [ { "versionId": 1, "lastUpdated": "2026-04-15T12:00:00Z", "source": "http://loinc.org", "profile": [ "example" ], "security": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "tag": [ { "system": "http://loinc.org", "version": "example", "code": "2986-8", "display": "example", "userSelected": true } ], "id": 1, "extension": [ {} ] } ], "implicitRules": "example", "language": "de" }'

Creates a FHIR R4B ServiceRequest resource.

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”
XDEBUG_SESSION
string
default: PHPSTORM

Xdebug session for debugging

Example
?XDEBUG_SESSION=PHPSTORM

Request Bodyrequired

Section titled “Request Bodyrequired”

The new FHIR R4B ServiceRequest resource

Media typeapplication/json
object
resourceType
string
default: ServiceRequest
identifier
Array<object>
object
use
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
codeableConcept
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
system
string | null
/\S*/
Example
http://loinc.org
value
string | null
period
Any of:
object
start
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
end
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
reference
Any of:
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
instantiatesCanonical
Array<string> | null
instantiatesUri
Array<string> | null
basedOn
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
replaces
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
requisition
Any of:
object
use
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
codeableConcept
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
system
string | null
/\S*/
Example
http://loinc.org
value
string | null
period
Any of:
object
start
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
end
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
reference
Any of:
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
status
string
default: draft
Allowed values: draft active on-hold revoked completed entered-in-error unknown
intent
string
default: proposal
category
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
priority
string | null
/[^\s]+(\s[^\s]+)*/
Example
asap
doNotPerform
boolean
code
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
orderDetail
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
quantityQuantity
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
quantityRatio
Any of:
object
numerator
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
denominator
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
quantityRange
Any of:
object
low
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
high
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
subject
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
encounter
Any of:
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
occurrenceDateTime
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
occurrencePeriod
Any of:
object
start
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
end
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
occurrenceTiming
Any of:
object
event
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
repeat
Any of:
object
boundsDuration
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
boundsRange
Any of:
object
low
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
high
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
Example
=
unit
string | null
system
string | null
/\S*/
Example
http://loinc.org
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
ABC
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
boundsPeriod
Any of:
object
start
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
end
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
count
integer | null
> 0
countMax
integer | null
> 0
duration
number | null
durationMax
number | null
durationUnit
string | null
/[^\s]+(\s[^\s]+)*/
Example
min
frequency
integer | null
> 0
frequencyMax
integer | null
> 0
period
number | null
periodMax
number | null
periodUnit
string | null
/[^\s]+(\s[^\s]+)*/
Example
min
dayOfWeek
string | null
/[^\s]+(\s[^\s]+)*/
Example
mon
timeOfDay
string | null format: date-time
Example
12:00:00
when
string | null
/[^\s]+(\s[^\s]+)*/
Example
HS
offset
integer | null
code
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
id
Any of:
integer
extension
Array<object>
object
asNeededBoolean
boolean | null
asNeededCodeableConcept
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
authoredOn
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
requester
Any of:
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
performerType
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
performer
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
locationCode
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
locationReference
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
reasonCode
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
reasonReference
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
insurance
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
supportingInfo
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
specimen
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
bodySite
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
text
string | null
note
Array<object>
object
authorReference
Any of:
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
authorString
string | null
time
string | null format: date-time
Example
2025-01-09T13:48:29+01:00
text
required
string
/\s*(\S|\s)*/
Example
# README
id
Any of:
integer
extension
Array<object>
object
patientInstruction
string | null
/[ \r\n\t\S]+/
Example
Text
relevantHistory
Array<object>
object
reference
string | null
type
string | null
/\S*/
Example
observations/1
identifier
object
display
string | null
id
Any of:
integer
extension
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*/
Example
http://loinc.org
profile
Array<string> | null
security
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
display
string | null
userSelected
boolean | null
tag
Array<object>
object
system
string | null
/\S*/
Example
http://loinc.org
version
string | null
code
string | null
/[^\s]+(\s[^\s]+)*/
Example
2986-8
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
de
pKV
boolean
healthInsuranceCompanyName
string | null
healthInsuranceSubscriberId
string | null

Responses

Section titled “Responses”

201

Section titled “201”

FHIR R4B ServiceRequest resource created

Media typeapplication/json
object
resourceType
string
default: ServiceRequest
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
instantiatesCanonical
Array<string> | null
instantiatesUri
Array<string> | null
basedOn
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
replaces
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
requisition
Any of:
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
status
string
default: draft
Allowed values: draft active on-hold revoked completed entered-in-error unknown
intent
string
default: proposal
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
priority
string | null
/[^\s]+(\s[^\s]+)*/
doNotPerform
boolean
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
orderDetail
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
quantityQuantity
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
quantityRatio
Any of:
object
numerator
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
denominator
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
quantityRange
Any of:
object
low
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
high
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
subject
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
occurrenceDateTime
string | null format: date-time
occurrencePeriod
Any of:
object
start
string | null format: date-time
end
string | null format: date-time
occurrenceTiming
Any of:
object
event
string | null format: date-time
repeat
Any of:
object
boundsDuration
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
boundsRange
Any of:
object
low
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
high
Any of:
object
value
number | null
comparator
string | null
/[^\s]+(\s[^\s]+)*/
unit
string | null
system
string | null
/\S*/
code
string | null
/[^\s]+(\s[^\s]+)*/
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
boundsPeriod
Any of:
object
start
string | null format: date-time
end
string | null format: date-time
count
integer | null
> 0
countMax
integer | null
> 0
duration
number | null
durationMax
number | null
durationUnit
string | null
/[^\s]+(\s[^\s]+)*/
frequency
integer | null
> 0
frequencyMax
integer | null
> 0
period
number | null
periodMax
number | null
periodUnit
string | null
/[^\s]+(\s[^\s]+)*/
dayOfWeek
string | null
/[^\s]+(\s[^\s]+)*/
timeOfDay
string | null format: date-time
when
string | null
/[^\s]+(\s[^\s]+)*/
offset
integer | 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
id
Any of:
integer
extension
Array<object>
object
asNeededBoolean
boolean | null
asNeededCodeableConcept
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
authoredOn
string | null format: date-time
requester
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
performerType
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
performer
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
locationCode
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
locationReference
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
reasonCode
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
reasonReference
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
insurance
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
supportingInfo
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
specimen
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
bodySite
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
authorReference
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
authorString
string | null
time
string | null format: date-time
text
required
string
/\s*(\S|\s)*/
id
Any of:
integer
extension
Array<object>
object
patientInstruction
string | null
/[ \r\n\t\S]+/
relevantHistory
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
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]+)*/
pKV
boolean
healthInsuranceCompanyName
string | null
healthInsuranceSubscriberId
string | null
Example
{
  "resourceType": "ServiceRequest",
  "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"
    }
  ],
  "replaces": [
    {
      "type": "observations/1"
    }
  ],
  "requisition": {
    "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"
    }
  },
  "status": "draft",
  "intent": "proposal",
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "2986-8"
        }
      ]
    }
  ],
  "priority": "asap",
  "doNotPerform": false,
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "2986-8"
      }
    ]
  },
  "orderDetail": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "2986-8"
        }
      ]
    }
  ],
  "quantityQuantity": {
    "comparator": "=",
    "system": "http://loinc.org",
    "code": "ABC"
  },
  "quantityRatio": {
    "numerator": {
      "comparator": "=",
      "system": "http://loinc.org",
      "code": "ABC"
    },
    "denominator": {
      "comparator": "=",
      "system": "http://loinc.org",
      "code": "ABC"
    }
  },
  "quantityRange": {
    "low": {
      "comparator": "=",
      "system": "http://loinc.org",
      "code": "ABC"
    },
    "high": {
      "comparator": "=",
      "system": "http://loinc.org",
      "code": "ABC"
    }
  },
  "subject": {
    "type": "observations/1"
  },
  "encounter": {
    "type": "observations/1"
  },
  "occurrenceDateTime": "2025-01-09T13:48:29+01:00",
  "occurrencePeriod": {
    "start": "2025-01-09T13:48:29+01:00",
    "end": "2025-01-09T13:48:29+01:00"
  },
  "occurrenceTiming": {
    "event": "2025-01-09T13:48:29+01:00",
    "repeat": {
      "boundsDuration": {
        "comparator": "=",
        "system": "http://loinc.org",
        "code": "ABC"
      },
      "boundsRange": {
        "low": {
          "comparator": "=",
          "system": "http://loinc.org",
          "code": "ABC"
        },
        "high": {
          "comparator": "=",
          "system": "http://loinc.org",
          "code": "ABC"
        }
      },
      "boundsPeriod": {
        "start": "2025-01-09T13:48:29+01:00",
        "end": "2025-01-09T13:48:29+01:00"
      },
      "durationUnit": "min",
      "periodUnit": "min",
      "dayOfWeek": "mon",
      "timeOfDay": "12:00:00",
      "when": "HS"
    },
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "2986-8"
        }
      ]
    }
  },
  "asNeededCodeableConcept": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "2986-8"
      }
    ]
  },
  "authoredOn": "2025-01-09T13:48:29+01:00",
  "requester": {
    "type": "observations/1"
  },
  "performerType": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "2986-8"
      }
    ]
  },
  "performer": [
    {
      "type": "observations/1"
    }
  ],
  "locationCode": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "2986-8"
        }
      ]
    }
  ],
  "locationReference": [
    {
      "type": "observations/1"
    }
  ],
  "reasonCode": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "2986-8"
        }
      ]
    }
  ],
  "reasonReference": [
    {
      "type": "observations/1"
    }
  ],
  "insurance": [
    {
      "type": "observations/1"
    }
  ],
  "supportingInfo": [
    {
      "type": "observations/1"
    }
  ],
  "specimen": [
    {
      "type": "observations/1"
    }
  ],
  "bodySite": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "2986-8"
        }
      ]
    }
  ],
  "note": [
    {
      "authorReference": {
        "type": "observations/1"
      },
      "time": "2025-01-09T13:48:29+01:00",
      "text": "# README"
    }
  ],
  "patientInstruction": "Text",
  "relevantHistory": [
    {
      "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"
}

400

Section titled “400”

Invalid input

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
}

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
}

422

Section titled “422”

An error occurred

Unprocessable entity

object
@context
One of:
string
@id
required
string
@type
required
string
status
integer
default: 422
violations
Array<object>
object
propertyPath
required

The property path of the violation

string
message
required

The message associated with the violation

string
code

The code of the violation

string
hint

An extra hint to understand the violation

string
payload

The serialized payload of the violation

object
key
additional properties
any
detail
string
description
string
type
string
title
string | null
instance
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 422
}