Skip to content
Probatix API Documentation

Retrieves the collection of FHIR R5 DiagnosticReport resources.

GET
/fhir/r5/diagnostic_reports
curl --request GET \
  --url 'http://api.probatix.localhost/fhir/r5/diagnostic_reports?page=1&XDEBUG_SESSION=PHPSTORM' \
  --header 'X-API-TOKEN: <X-API-TOKEN>' \
  --header 'accept-language: de'

Retrieves the collection of FHIR R5 DiagnosticReport resources.

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”
page
integer
default: 1 >= 1

The collection page number

XDEBUG_SESSION
string
default: PHPSTORM

Xdebug session for debugging

Example
?XDEBUG_SESSION=PHPSTORM

Responses

Section titled “Responses”

200

Section titled “200”

FHIR R5 DiagnosticReport collection

Media typeapplication/json
Array<object>
object
resourceType
string
default: DiagnosticReport
identifier
Array<object>
object
use
string | null
/[^\s]+( [^\s]+)*/
codeableConcept
Any of:
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+( [^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
system
string | null
/\S*/
value
string | null
period
Any of:
object
start
string | null format: date-time
end
string | null format: date-time
reference
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
id
Any of:
integer
extension
Array<object>
object
basedOn
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
status
string
default: final /[^\s]+( [^\s]+)*/
category
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+( [^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
code
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+( [^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
subject
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
encounter
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
effectiveDateTime
string | null format: date-time
effectivePeriod
Any of:
object
start
string | null format: date-time
end
string | null format: date-time
issued
string | null format: date-time
performer
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
resultsInterpreter
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
result
Array<object>
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
note
Array<object>
object
study
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
media
Array<object>
object
composition
Any of:
object
reference
string | null
type
string | null
/\S*/
identifier
object
display
string | null
id
Any of:
integer
extension
Array<object>
object
conclusion
string | null
/^[\s\S]+$/
conclusionCode
Array<object>
object
coding
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\s]+( [^\s]+)*/
display
string | null
userSelected
boolean | null
text
string | null
presentedForm
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]+)*/
display
string | null
userSelected
boolean | null
tag
Array<object>
object
system
string | null
/\S*/
version
string | null
code
string | null
/[^\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]+)*/
Example
[
  {
    "resourceType": "DiagnosticReport",
    "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"
      }
    ],
    "status": "final",
    "category": [
      {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "AAA-000"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "AAA-000"
        }
      ]
    },
    "subject": {
      "type": "observations/1"
    },
    "encounter": {
      "type": "observations/1"
    },
    "effectiveDateTime": "2025-01-09T13:48:29+01:00",
    "effectivePeriod": {
      "start": "2025-01-09T13:48:29+01:00",
      "end": "2025-01-09T13:48:29+01:00"
    },
    "performer": [
      {
        "type": "observations/1"
      }
    ],
    "resultsInterpreter": [
      {
        "type": "observations/1"
      }
    ],
    "specimen": [
      {
        "type": "observations/1"
      }
    ],
    "result": [
      {
        "type": "observations/1"
      }
    ],
    "study": [
      {
        "type": "observations/1"
      }
    ],
    "composition": {
      "type": "observations/1"
    },
    "conclusion": "# README",
    "conclusionCode": [
      {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "AAA-000"
          }
        ]
      }
    ],
    "meta": [
      {
        "source": "http://loinc.org",
        "security": [
          {
            "system": "http://loinc.org",
            "code": "AAA-000"
          }
        ],
        "tag": [
          {
            "system": "http://loinc.org",
            "code": "AAA-000"
          }
        ]
      }
    ],
    "language": "de"
  }
]

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
}