Retrieves a FHIR R4B ServiceRequest resource.

GET

/fhir/r4b/service_requests/{id}

const url = 'http://api.probatix.localhost/fhir/r4b/service_requests/example?XDEBUG_SESSION=PHPSTORM';
const options = {
  method: 'GET',
  headers: {'accept-language': 'de', 'X-API-TOKEN': '<X-API-TOKEN>'}
};

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

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

Authorizations

apiKey

Parameters

Path Parameters

required

string

FHIR R4B ServiceRequest identifier

Header Parameters

accept-language

string

Allowed values: de en fr

Language for Errors and Translatable properties

Example

de

Query Parameters

XDEBUG_SESSION

string

default: PHPSTORM

Xdebug session for debugging

Example

?XDEBUG_SESSION=PHPSTORM

Responses

200

FHIR R4B ServiceRequest resource

application/json

object

resourceType

string

default: ServiceRequest

identifier

Array<object>

object

use

string | null

/[^\s]+(\s[^\s]+)*/

codeableConcept

Any of:

object
null

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
null

object

start

string | null format: date-time

end

string | null format: date-time

reference

Any of:

object
null

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

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

Any of:

integer

extension

Array<object>

object

replaces

Array<object>

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

requisition

Any of:

object
null

object

use

string | null

/[^\s]+(\s[^\s]+)*/

codeableConcept

Any of:

object
null

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
null

object

start

string | null format: date-time

end

string | null format: date-time

reference

Any of:

object
null

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

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
null

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
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

quantityRatio

Any of:

object
null

object

numerator

Any of:

object
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

denominator

Any of:

object
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

Any of:

integer

extension

Array<object>

object

quantityRange

Any of:

object
null

object

low

Any of:

object
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

high

Any of:

object
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

Any of:

integer

extension

Array<object>

object

subject

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

encounter

Any of:

object
null

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

occurrenceDateTime

string | null format: date-time

occurrencePeriod

Any of:

object
null

object

start

string | null format: date-time

end

string | null format: date-time

occurrenceTiming

Any of:

object
null

object

event

string | null format: date-time

repeat

Any of:

object
null

object

boundsDuration

Any of:

object
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

boundsRange

Any of:

object
null

object

low

Any of:

object
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

high

Any of:

object
null

object

value

number | null

comparator

string | null

/[^\s]+(\s[^\s]+)*/

unit

string | null

system

string | null

/\S*/

code

string | null

/[^\s]+(\s[^\s]+)*/

Any of:

integer

extension

Array<object>

object

Any of:

integer

extension

Array<object>

object

boundsPeriod

Any of:

object
null

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
null

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

Any of:

integer

extension

Array<object>

object

asNeededBoolean

boolean | null

asNeededCodeableConcept

Any of:

object
null

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
null

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

performerType

Any of:

object
null

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

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

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

Any of:

integer

extension

Array<object>

object

insurance

Array<object>

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

supportingInfo

Array<object>

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

specimen

Array<object>

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

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
null

object

reference

string | null

type

string | null

/\S*/

identifier

object

display

string | null

Any of:

integer

extension

Array<object>

object

authorString

string | null

time

string | null format: date-time

text

required

string

/\s*(\S|\s)*/

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

Any of:

integer

extension

Array<object>

object

text

object

contained

Array<object>

object

extension

Array<object>

object

modifierExtension

Array<object>

object

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

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

401

Unauthorized

A representation of common errors.

object

@context

One of:

string
object

string

@id

required

string

@type

required

string

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

description

string | null

Example

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}

A representation of common errors.

object

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

Example

{
  "status": 400
}

A representation of common errors.

object

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

Example

{
  "status": 400
}

403

Forbidden

A representation of common errors.

object

@context

One of:

string
object

string

@id

required

string

@type

required

string

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

description

string | null

Example

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}

A representation of common errors.

object

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

Example

{
  "status": 400
}

A representation of common errors.

object

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

Example

{
  "status": 400
}

404

Not found

A representation of common errors.

object

@context

One of:

string
object

string

@id

required

string

@type

required

string

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

description

string | null

Example

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}

A representation of common errors.

object

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

Example

{
  "status": 400
}

A representation of common errors.

object

title

A short, human-readable summary of the problem.

string | null

detail

A human-readable explanation specific to this occurrence of the problem.

string | null

status

integer | null

default: 400

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null

type

A URI reference that identifies the problem type

string

Example

{
  "status": 400
}