R5
Creates a FHIR R5 ServiceRequest resource.
Creates a FHIR R5 ServiceRequest resource.
Creates a FHIR R5 ServiceRequest resource.
Authorization
apiKey X-API-TOKEN<token>
In: header
Header Parameters
accept-language?string
Language for Errors and Translatable properties
Allowed values: "de", "en", "fr"
Request Body
application/json
The new FHIR R5 ServiceRequest resource
TypeScript Definitions
Use the request body type in TypeScript.
body*FHIR.R5.ServiceRequest
resourceType?string
identifier?array<FHIR.R5.Datatypes.Identifier>
instantiatesCanonical?array | null
instantiatesUri?array | null
basedOn?array<FHIR.R5.Datatypes.Reference>
replaces?array<FHIR.R5.Datatypes.Reference>
requisition?FHIR.R5.Datatypes.Identifier | null
use?string | null
codeableConcept?FHIR.R5.Datatypes.CodeableConcept | null
coding?array<FHIR.R5.Datatypes.Coding>
text?string | null
system?string | null
value?string | null
period?FHIR.R5.Datatypes.Period | null
start?string | null
end?string | null
reference?FHIR.R5.Datatypes.Reference | null
reference?string | null
type?string | null
identifier?object
display?string | null
id?integer | string | null
extension?array<object>
id?integer | string | null
extension?array<object>
status?string
Allowed values: "draft", "active", "on-hold", "revoked", "completed", "entered-in-error", "unknown"
intent?string
category?array<FHIR.R5.Datatypes.CodeableConcept>
priority?string | null
doNotPerform?boolean
code?FHIR.R5.Datatypes.CodeableReference | null
concept?FHIR.R5.Datatypes.CodeableConcept | null
coding?array<FHIR.R5.Datatypes.Coding>
text?string | null
reference?FHIR.R5.Datatypes.Reference | null
reference?string | null
type?string | null
identifier?object
display?string | null
id?integer | string | null
extension?array<object>
id?integer | string | null
extension?array<object>
orderDetail?array<FHIR.R5.Resources.ServiceRequest.OrderDetail>
quantityQuantity?FHIR.R5.Datatypes.Quantity | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
quantityRatio?FHIR.R5.Datatypes.Ratio | null
numerator?FHIR.R5.Datatypes.Quantity | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
denominator?FHIR.R5.Datatypes.Quantity | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
id?integer | string | null
extension?array<object>
quantityRange?FHIR.R5.Datatypes.Range | null
low?FHIR.R5.Datatypes.Quantity | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
high?FHIR.R5.Datatypes.Quantity | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
id?integer | string | null
extension?array<object>
subject?FHIR.R5.Datatypes.Reference
reference?string | null
type?string | null
identifier?object
display?string | null
id?integer | string | null
extension?array<object>
focus?array<FHIR.R5.Datatypes.Reference>
encounter?FHIR.R5.Datatypes.Reference | null
reference?string | null
type?string | null
identifier?object
display?string | null
id?integer | string | null
extension?array<object>
occurrenceDateTime?string | null
occurrencePeriod?FHIR.R5.Datatypes.Period | null
start?string | null
end?string | null
occurrenceTiming?FHIR.R5.Datatypes.Timing | null
event?string | null
repeat?FHIR.R5.Datatypes.Timing.Repeat | null
boundsDuration?FHIR.R5.Datatypes.Duration | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
boundsRange?FHIR.R5.Datatypes.Range | null
low?FHIR.R5.Datatypes.Quantity | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
high?FHIR.R5.Datatypes.Quantity | null
value?number | null
comparator?string | null
unit?string | null
system?string | null
code?string | null
id?integer | string | null
extension?array<object>
id?integer | string | null
extension?array<object>
boundsPeriod?FHIR.R5.Datatypes.Period | null
start?string | null
end?string | null
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
when?string | null
offset?integer | null
code?FHIR.R5.Datatypes.CodeableConcept | null
coding?array<FHIR.R5.Datatypes.Coding>
text?string | null
id?integer | string | null
extension?array<object>
asNeededBoolean?boolean | null
asNeededCodeableConcept?FHIR.R5.Datatypes.CodeableConcept | null
coding?array<FHIR.R5.Datatypes.Coding>
text?string | null
authoredOn?string | null
requester?FHIR.R5.Datatypes.Reference | null
reference?string | null
type?string | null
identifier?object
display?string | null
id?integer | string | null
extension?array<object>
performerType?FHIR.R5.Datatypes.CodeableConcept | null
coding?array<FHIR.R5.Datatypes.Coding>
text?string | null
performer?array<FHIR.R5.Datatypes.Reference>
location?array<FHIR.R5.Datatypes.CodeableReference>
reason?array<FHIR.R5.Datatypes.CodeableReference>
insurance?array<FHIR.R5.Datatypes.Reference>
supportingInfo?array<FHIR.R5.Datatypes.CodeableReference>
specimen?array<FHIR.R5.Datatypes.Reference>
bodySite?array<FHIR.R5.Datatypes.CodeableConcept>
bodyStructure?FHIR.R5.Datatypes.Reference | null
reference?string | null
type?string | null
identifier?object
display?string | null
id?integer | string | null
extension?array<object>
note?array<FHIR.R5.Datatypes.Annotation>
patientInstruction?FHIR.R5.Resources.ServiceRequest.PatientInstruction | null
instructionMarkdown?string | null
instructionReference?FHIR.R5.Datatypes.Reference | null
reference?string | null
type?string | null
identifier?object
display?string | null
id?integer | string | null
extension?array<object>
modifierExtension?array | null
id?integer | string | null
extension?array<object>
relevantHistory?array<FHIR.R5.Datatypes.Reference>
text?object
contained?array<object>
extension?array<object>
modifierExtension?array<object>
id?integer | string | null
meta?array<FHIR.R5.Resources.Meta>
implicitRules?string | null
language?string | null
pKV?boolean
healthInsuranceCompanyName?string | null
healthInsuranceSubscriberId?string | null
Response Body
application/json
curl -X POST "https://example.com/fhir/r5/service_requests" \ -H "accept-language: de" \ -H "Content-Type: application/json" \ -d '{}'{ "resourceType": "ServiceRequest", "identifier": [ { "use": "string", "codeableConcept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "system": "string", "value": "string", "period": { "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z" }, "reference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] } ], "instantiatesCanonical": [ "string" ], "instantiatesUri": [ "string" ], "basedOn": [ { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] } ], "replaces": [ { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] } ], "requisition": { "use": "string", "codeableConcept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "system": "string", "value": "string", "period": { "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z" }, "reference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] }, "status": "draft", "intent": "proposal", "category": [ { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" } ], "priority": "string", "doNotPerform": false, "code": { "concept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "reference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] }, "orderDetail": [ { "parameterFocus": { "concept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "reference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] }, "parameter": [ { "code": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "valueQuantity": {}, "valueRatio": {}, "valueRange": {}, "valueBoolean": true, "valueCodeableConcept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "valueString": "string", "valuePeriod": { "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z" }, "modifierExtension": [ "string" ], "id": 0, "extension": [ {} ] } ], "modifierExtension": [ "string" ], "id": 0, "extension": [ {} ] } ], "quantityQuantity": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "quantityRatio": { "numerator": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "denominator": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] }, "quantityRange": { "low": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "high": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] }, "subject": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "focus": [ { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] } ], "encounter": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "occurrenceDateTime": "2019-08-24T14:15:22Z", "occurrencePeriod": { "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z" }, "occurrenceTiming": { "event": "2019-08-24T14:15:22Z", "repeat": { "boundsDuration": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "boundsRange": { "low": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "high": { "value": 0, "comparator": "string", "unit": "string", "system": "string", "code": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] }, "boundsPeriod": { "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z" }, "count": 0, "countMax": 0, "duration": 0, "durationMax": 0, "durationUnit": "string", "frequency": 0, "frequencyMax": 0, "period": 0, "periodMax": 0, "periodUnit": "string", "dayOfWeek": "string", "timeOfDay": "2019-08-24T14:15:22Z", "when": "string", "offset": 0 }, "code": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "id": 0, "extension": [ {} ] }, "asNeededBoolean": true, "asNeededCodeableConcept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "authoredOn": "2019-08-24T14:15:22Z", "requester": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "performerType": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "performer": [ { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] } ], "location": [ { "concept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "reference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] } ], "reason": [ { "concept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "reference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] } ], "insurance": [ { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] } ], "supportingInfo": [ { "concept": { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" }, "reference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "id": 0, "extension": [ {} ] } ], "specimen": [ { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] } ], "bodySite": [ { "coding": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "text": "string" } ], "bodyStructure": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "note": [ { "authorReference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "authorString": "string", "time": "2019-08-24T14:15:22Z", "text": "string", "id": 0, "extension": [ {} ] } ], "patientInstruction": { "instructionMarkdown": "string", "instructionReference": { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] }, "modifierExtension": [ "string" ], "id": 0, "extension": [ {} ] }, "relevantHistory": [ { "reference": "string", "type": "string", "identifier": {}, "display": "string", "id": 0, "extension": [ {} ] } ], "text": {}, "contained": [ {} ], "extension": [ {} ], "modifierExtension": [ {} ], "id": 0, "meta": [ { "versionId": 0, "lastUpdated": "2019-08-24T14:15:22Z", "source": "string", "profile": [ "string" ], "security": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "tag": [ { "system": "string", "version": "string", "code": "string", "display": "string", "userSelected": true } ], "id": 0, "extension": [ {} ] } ], "implicitRules": "string", "language": "string", "pKV": true, "healthInsuranceCompanyName": "string", "healthInsuranceSubscriberId": "string"}