Creates a FHIR R5 ServiceRequest resource.
POST
/fhir/r5/service_requests
const url = 'http://api.probatix.localhost/fhir/r5/service_requests?XDEBUG_SESSION=PHPSTORM';const options = { method: 'POST', headers: { 'accept-language': 'de', 'X-API-TOKEN': '<X-API-TOKEN>', 'Content-Type': 'application/json' }, body: '{"resourceType":"ServiceRequest","identifier":[{"use":"2986-8","codeableConcept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","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":"AAA-000","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":"AAA-000","display":"example","userSelected":true}],"text":"example"}],"priority":"asap","doNotPerform":false,"code":{"concept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"},"reference":{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]},"id":1,"extension":[{}]},"orderDetail":[{"parameterFocus":{"concept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"},"reference":{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]},"id":1,"extension":[{}]},"parameter":[{"code":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"},"valueQuantity":{},"valueRatio":{},"valueRange":{},"valueBoolean":true,"valueCodeableConcept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"},"valueString":"example","valuePeriod":{"start":"2025-01-09T13:48:29+01:00","end":"2025-01-09T13:48:29+01:00"},"modifierExtension":["example"],"id":1,"extension":[{}]}],"modifierExtension":["example"],"id":1,"extension":[{}]}],"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":[{}]},"focus":[{"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":"AAA-000","display":"example","userSelected":true}],"text":"example"},"id":1,"extension":[{}]},"asNeededBoolean":true,"asNeededCodeableConcept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","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":"AAA-000","display":"example","userSelected":true}],"text":"example"},"performer":[{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]}],"location":[{"concept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"},"reference":{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]},"id":1,"extension":[{}]}],"reason":[{"concept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"},"reference":{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]},"id":1,"extension":[{}]}],"insurance":[{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]}],"supportingInfo":[{"concept":{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"},"reference":{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]},"id":1,"extension":[{}]}],"specimen":[{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]}],"bodySite":[{"coding":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"text":"example"}],"bodyStructure":{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]},"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":{"instructionMarkdown":"# README","instructionReference":{"reference":"example","type":"observations/1","identifier":{},"display":"example","id":1,"extension":[{}]},"modifierExtension":["example"],"id":1,"extension":[{}]},"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":"AAA-000","display":"example","userSelected":true}],"tag":[{"system":"http://loinc.org","version":"example","code":"AAA-000","display":"example","userSelected":true}],"id":1,"extension":[{}]}],"implicitRules":"example","language":"de"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'http://api.probatix.localhost/fhir/r5/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": "AAA-000", "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": "AAA-000", "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": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" } ], "priority": "asap", "doNotPerform": false, "code": { "concept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "reference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] }, "orderDetail": [ { "parameterFocus": { "concept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "reference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] }, "parameter": [ { "code": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "valueQuantity": {}, "valueRatio": {}, "valueRange": {}, "valueBoolean": true, "valueCodeableConcept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "valueString": "example", "valuePeriod": { "start": "2025-01-09T13:48:29+01:00", "end": "2025-01-09T13:48:29+01:00" }, "modifierExtension": [ "example" ], "id": 1, "extension": [ {} ] } ], "modifierExtension": [ "example" ], "id": 1, "extension": [ {} ] } ], "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": [ {} ] }, "focus": [ { "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": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "id": 1, "extension": [ {} ] }, "asNeededBoolean": true, "asNeededCodeableConcept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "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": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "performer": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "location": [ { "concept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "reference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] } ], "reason": [ { "concept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "reference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] } ], "insurance": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "supportingInfo": [ { "concept": { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" }, "reference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "id": 1, "extension": [ {} ] } ], "specimen": [ { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] } ], "bodySite": [ { "coding": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "text": "example" } ], "bodyStructure": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "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": { "instructionMarkdown": "# README", "instructionReference": { "reference": "example", "type": "observations/1", "identifier": {}, "display": "example", "id": 1, "extension": [ {} ] }, "modifierExtension": [ "example" ], "id": 1, "extension": [ {} ] }, "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": "AAA-000", "display": "example", "userSelected": true } ], "tag": [ { "system": "http://loinc.org", "version": "example", "code": "AAA-000", "display": "example", "userSelected": true } ], "id": 1, "extension": [ {} ] } ], "implicitRules": "example", "language": "de" }'Creates a FHIR R5 ServiceRequest resource.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”accept-language
string
Language for Errors and Translatable properties
Example
deQuery Parameters
Section titled “Query Parameters”XDEBUG_SESSION
string
Xdebug session for debugging
Example
?XDEBUG_SESSION=PHPSTORMRequest Bodyrequired
Section titled “Request Bodyrequired”The new FHIR R5 ServiceRequest resource
Media typeapplication/json
object
resourceType
string
identifier
Array<object>
object
use
string | null
Example
2986-8codeableConcept
system
string | null
Example
http://loinc.orgvalue
string | null
period
reference
extension
Array<object>
object
instantiatesCanonical
Array<string> | null
instantiatesUri
Array<string> | null
basedOn
replaces
requisition
Any of:
object
use
string | null
Example
2986-8codeableConcept
system
string | null
Example
http://loinc.orgvalue
string | null
period
reference
extension
Array<object>
object
null
status
string
intent
string
category
Array<object>
object
coding
Array<object>
object
system
string | null
Example
http://loinc.orgversion
string | null
code
string | null
Example
AAA-000display
string | null
userSelected
boolean | null
text
string | null
priority
string | null
Example
asapdoNotPerform
boolean
code
Any of:
object
concept
reference
extension
Array<object>
object
null
orderDetail
Array<object>
object
parameterFocus
Any of:
object
concept
reference
extension
Array<object>
object
null
parameter
Array<object>
object
code
object
coding
Array<object>
object
system
string | null
Example
http://loinc.orgversion
string | null
code
string | null
Example
AAA-000display
string | null
userSelected
boolean | null
text
string | null
valueQuantity
object
valueRatio
object
valueRange
object
valueBoolean
boolean | null
valueCodeableConcept
valueString
string | null
valuePeriod
modifierExtension
Array<string | null> | null
extension
Array<object>
object
modifierExtension
Array<string | null> | null
extension
Array<object>
object
quantityQuantity
quantityRatio
Any of:
object
numerator
denominator
extension
Array<object>
object
null
quantityRange
Any of:
object
low
high
extension
Array<object>
object
null
subject
focus
encounter
occurrenceDateTime
string | null format: date-time
Example
2025-01-09T13:48:29+01:00occurrencePeriod
occurrenceTiming
Any of:
object
event
string | null format: date-time
Example
2025-01-09T13:48:29+01:00repeat
Any of:
object
boundsDuration
boundsRange
Any of:
object
low
high
extension
Array<object>
object
null
boundsPeriod
count
integer | null
countMax
integer | null
duration
number | null
durationMax
number | null
durationUnit
string | null
Example
minfrequency
integer | null
frequencyMax
integer | null
period
number | null
periodMax
number | null
periodUnit
string | null
Example
mindayOfWeek
string | null
Example
montimeOfDay
string | null format: date-time
Example
12:00:00when
string | null
Example
HSoffset
integer | null
null
code
extension
Array<object>
object
null
asNeededBoolean
boolean | null
asNeededCodeableConcept
authoredOn
string | null format: date-time
Example
2025-01-09T13:48:29+01:00requester
performerType
performer
location
Array<object>
object
concept
reference
extension
Array<object>
object
reason
Array<object>
object
concept
reference
extension
Array<object>
object
insurance
supportingInfo
Array<object>
object
concept
reference
extension
Array<object>
object
specimen
bodySite
Array<object>
object
coding
Array<object>
object
system
string | null
Example
http://loinc.orgversion
string | null
code
string | null
Example
AAA-000display
string | null
userSelected
boolean | null
text
string | null
bodyStructure
note
Array<object>
object
authorReference
authorString
string | null
time
string | null format: date-time
Example
2025-01-09T13:48:29+01:00text
required
string
Example
# READMEextension
Array<object>
object
patientInstruction
Any of:
object
instructionMarkdown
string | null
Example
# READMEinstructionReference
modifierExtension
Array<string | null> | null
extension
Array<object>
object
null
relevantHistory
text
object
contained
Array<object>
object
extension
Array<object>
object
modifierExtension
Array<object>
object
meta
Array<object>
object
lastUpdated
string | null format: date-time
source
string | null
Example
http://loinc.orgprofile
Array<string> | null
security
Array<object>
object
system
string | null
Example
http://loinc.orgversion
string | null
code
string | null
Example
AAA-000display
string | null
userSelected
boolean | null
tag
Array<object>
object
system
string | null
Example
http://loinc.orgversion
string | null
code
string | null
Example
AAA-000display
string | null
userSelected
boolean | null
extension
Array<object>
object
implicitRules
string | null
language
string | null
Example
depKV
boolean
healthInsuranceCompanyName
string | null
healthInsuranceSubscriberId
string | null
Responses
Section titled “Responses”FHIR R5 ServiceRequest resource created
Media typeapplication/json
object
resourceType
string
identifier
Array<object>
object
use
string | null
codeableConcept
system
string | null
value
string | null
period
reference
extension
Array<object>
object
instantiatesCanonical
Array<string> | null
instantiatesUri
Array<string> | null
basedOn
replaces
requisition
Any of:
object
use
string | null
codeableConcept
system
string | null
value
string | null
period
reference
extension
Array<object>
object
null
status
string
intent
string
category
Array<object>
object
coding
Array<object>
object
system
string | null
version
string | null
code
string | null
display
string | null
userSelected
boolean | null
text
string | null
priority
string | null
doNotPerform
boolean
code
Any of:
object
concept
reference
extension
Array<object>
object
null
orderDetail
Array<object>
object
parameterFocus
Any of:
object
concept
reference
extension
Array<object>
object
null
parameter
Array<object>
object
code
object
coding
Array<object>
object
system
string | null
version
string | null
code
string | null
display
string | null
userSelected
boolean | null
text
string | null
valueQuantity
object
valueRatio
object
valueRange
object
valueBoolean
boolean | null
valueCodeableConcept
valueString
string | null
valuePeriod
modifierExtension
Array<string | null> | null
extension
Array<object>
object
modifierExtension
Array<string | null> | null
extension
Array<object>
object
quantityQuantity
quantityRatio
Any of:
object
numerator
denominator
extension
Array<object>
object
null
quantityRange
Any of:
object
low
high
extension
Array<object>
object
null
subject
focus
encounter
occurrenceDateTime
string | null format: date-time
occurrencePeriod
occurrenceTiming
Any of:
object
event
string | null format: date-time
repeat
Any of:
object
boundsDuration
boundsRange
Any of:
object
low
high
extension
Array<object>
object
null
boundsPeriod
count
integer | null
countMax
integer | null
duration
number | null
durationMax
number | null
durationUnit
string | null
frequency
integer | null
frequencyMax
integer | null
period
number | null
periodMax
number | null
periodUnit
string | null
dayOfWeek
string | null
timeOfDay
string | null format: date-time
when
string | null
offset
integer | null
null
code
extension
Array<object>
object
null
asNeededBoolean
boolean | null
asNeededCodeableConcept
authoredOn
string | null format: date-time
requester
performerType
performer
location
Array<object>
object
concept
reference
extension
Array<object>
object
reason
Array<object>
object
concept
reference
extension
Array<object>
object
insurance
supportingInfo
Array<object>
object
concept
reference
extension
Array<object>
object
specimen
bodySite
Array<object>
object
coding
Array<object>
object
system
string | null
version
string | null
code
string | null
display
string | null
userSelected
boolean | null
text
string | null
bodyStructure
note
Array<object>
object
authorReference
authorString
string | null
time
string | null format: date-time
text
required
string
extension
Array<object>
object
patientInstruction
Any of:
object
instructionMarkdown
string | null
instructionReference
modifierExtension
Array<string | null> | null
extension
Array<object>
object
null
relevantHistory
text
object
contained
Array<object>
object
extension
Array<object>
object
modifierExtension
Array<object>
object
meta
Array<object>
object
lastUpdated
string | null format: date-time
source
string | null
profile
Array<string> | null
security
Array<object>
object
system
string | null
version
string | null
code
string | null
display
string | null
userSelected
boolean | null
tag
Array<object>
object
system
string | null
version
string | null
code
string | null
display
string | null
userSelected
boolean | null
extension
Array<object>
object
implicitRules
string | null
language
string | null
pKV
boolean
healthInsuranceCompanyName
string | null
healthInsuranceSubscriberId
string | null
Example
{ "resourceType": "ServiceRequest", "identifier": [ { "use": "2986-8", "codeableConcept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "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": "AAA-000" } ] }, "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": "AAA-000" } ] } ], "priority": "asap", "doNotPerform": false, "code": { "concept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "reference": { "type": "observations/1" } }, "orderDetail": [ { "parameterFocus": { "concept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "reference": { "type": "observations/1" } }, "parameter": [ { "code": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "valueCodeableConcept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "valuePeriod": { "start": "2025-01-09T13:48:29+01:00", "end": "2025-01-09T13:48:29+01:00" } } ] } ], "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" }, "focus": [ { "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": "AAA-000" } ] } }, "asNeededCodeableConcept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "authoredOn": "2025-01-09T13:48:29+01:00", "requester": { "type": "observations/1" }, "performerType": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "performer": [ { "type": "observations/1" } ], "location": [ { "concept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "reference": { "type": "observations/1" } } ], "reason": [ { "concept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "reference": { "type": "observations/1" } } ], "insurance": [ { "type": "observations/1" } ], "supportingInfo": [ { "concept": { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] }, "reference": { "type": "observations/1" } } ], "specimen": [ { "type": "observations/1" } ], "bodySite": [ { "coding": [ { "system": "http://loinc.org", "code": "AAA-000" } ] } ], "bodyStructure": { "type": "observations/1" }, "note": [ { "authorReference": { "type": "observations/1" }, "time": "2025-01-09T13:48:29+01:00", "text": "# README" } ], "patientInstruction": { "instructionMarkdown": "# README", "instructionReference": { "type": "observations/1" } }, "relevantHistory": [ { "type": "observations/1" } ], "meta": [ { "source": "http://loinc.org", "security": [ { "system": "http://loinc.org", "code": "AAA-000" } ], "tag": [ { "system": "http://loinc.org", "code": "AAA-000" } ] } ], "language": "de"}Invalid input
A representation of common errors.
object
@context
@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
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
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
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}Unauthorized
A representation of common errors.
object
@context
@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
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
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
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}Forbidden
A representation of common errors.
object
@context
@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
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
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
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}An error occurred
Unprocessable entity
object
@context
@id
required
string
@type
required
string
status
integer
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}Unprocessable entity
object
status
integer
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
type
string
title
string | null
instance
string | null
Example
{ "status": 422}Unprocessable entity
object
status
integer
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
type
string
title
string | null
instance
string | null
Example
{ "status": 422}