{ "openapi": "3.2.0", "info": { "title": "FHIR R5 API", "description": "", "version": "1.28.0" }, "servers": [ { "url": "https://api.sandbox.probatix.de/", "description": "Sandbox environment for E2E testing." }, { "url": "https://api.probatix.de/", "description": "Production environment." } ], "paths": { "/fhir/r5/diagnostic_reports": { "get": { "operationId": "api_fhirr5diagnostic_reports_get_collection", "tags": [ "Diagnostic Reports" ], "responses": { "200": { "description": "FHIR R5 DiagnosticReport collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.DiagnosticReport" } } } } }, "401": { "description": "Unauthorized", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves the collection of FHIR R5 DiagnosticReport resources.", "description": "Retrieves the collection of FHIR R5 DiagnosticReport resources.", "parameters": [ { "name": "accept-language", "in": "header", "description": "Language for Errors and Translatable properties", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "de", "en", "fr" ] }, "style": "simple", "explode": false, "example": "de" }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "style": "form", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "FHIR_R5" ] } }, "/fhir/r5/diagnostic_reports/{id}": { "get": { "operationId": "api_fhirr5diagnostic_reports_id_get", "tags": [ "Diagnostic Reports" ], "responses": { "200": { "description": "FHIR R5 DiagnosticReport resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FHIR.R5.DiagnosticReport" } } } }, "401": { "description": "Unauthorized", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a FHIR R5 DiagnosticReport resource.", "description": "Retrieves a FHIR R5 DiagnosticReport resource.", "parameters": [ { "name": "accept-language", "in": "header", "description": "Language for Errors and Translatable properties", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "de", "en", "fr" ] }, "style": "simple", "explode": false, "example": "de" }, { "name": "id", "in": "path", "description": "FHIR R5 DiagnosticReport identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "FHIR_R5" ] } }, "/fhir/r5/observations": { "get": { "operationId": "api_fhirr5observations_get_collection", "tags": [ "Observations" ], "responses": { "200": { "description": "FHIR R5 Observation collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Observation" } } } } }, "401": { "description": "Unauthorized", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves the collection of FHIR R5 Observation resources.", "description": "Retrieves the collection of FHIR R5 Observation resources.", "parameters": [ { "name": "accept-language", "in": "header", "description": "Language for Errors and Translatable properties", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "de", "en", "fr" ] }, "style": "simple", "explode": false, "example": "de" }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "style": "form", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "FHIR_R5" ] } }, "/fhir/r5/observations/{id}": { "get": { "operationId": "api_fhirr5observations_id_get", "tags": [ "Observations" ], "responses": { "200": { "description": "FHIR R5 Observation resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FHIR.R5.Observation" } } } }, "401": { "description": "Unauthorized", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a FHIR R5 Observation resource.", "description": "Retrieves a FHIR R5 Observation resource.", "parameters": [ { "name": "accept-language", "in": "header", "description": "Language for Errors and Translatable properties", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "de", "en", "fr" ] }, "style": "simple", "explode": false, "example": "de" }, { "name": "id", "in": "path", "description": "FHIR R5 Observation identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "FHIR_R5" ] } }, "/fhir/r5/service_requests": { "get": { "operationId": "api_fhirr5service_requests_get_collection", "tags": [ "Service Requests" ], "responses": { "200": { "description": "FHIR R5 ServiceRequest collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.ServiceRequest" } } } } }, "401": { "description": "Unauthorized", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves the collection of FHIR R5 ServiceRequest resources.", "description": "Retrieves the collection of FHIR R5 ServiceRequest resources.", "parameters": [ { "name": "accept-language", "in": "header", "description": "Language for Errors and Translatable properties", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "de", "en", "fr" ] }, "style": "simple", "explode": false, "example": "de" }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "style": "form", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "FHIR_R5" ] }, "post": { "operationId": "api_fhirr5service_requests_post", "tags": [ "Service Requests" ], "responses": { "201": { "description": "FHIR R5 ServiceRequest resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FHIR.R5.ServiceRequest" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "401": { "description": "Unauthorized", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Creates a FHIR R5 ServiceRequest resource.", "description": "Creates a FHIR R5 ServiceRequest resource.", "parameters": [ { "name": "accept-language", "in": "header", "description": "Language for Errors and Translatable properties", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "de", "en", "fr" ] }, "style": "simple", "explode": false, "example": "de" } ], "requestBody": { "description": "The new FHIR R5 ServiceRequest resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FHIR.R5.ServiceRequest" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "FHIR_R5" ] } }, "/fhir/r5/service_requests/{id}": { "get": { "operationId": "api_fhirr5service_requests_id_get", "tags": [ "Service Requests" ], "responses": { "200": { "description": "FHIR R5 ServiceRequest resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FHIR.R5.ServiceRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a FHIR R5 ServiceRequest resource.", "description": "Retrieves a FHIR R5 ServiceRequest resource.", "parameters": [ { "name": "accept-language", "in": "header", "description": "Language for Errors and Translatable properties", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "de", "en", "fr" ] }, "style": "simple", "explode": false, "example": "de" }, { "name": "id", "in": "path", "description": "FHIR R5 ServiceRequest identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "FHIR_R5" ] } } }, "components": { "schemas": { "ConstraintViolation": { "type": "object", "description": "Unprocessable entity", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } }, "ConstraintViolation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "Unprocessable entity" }, "Error": { "type": "object", "description": "A representation of common errors.", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" } } }, "Error.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" }, "description": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "A representation of common errors." }, "FHIR.R5.Datatypes.Annotation": { "type": "object", "properties": { "authorReference": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "authorString": { "type": [ "string", "null" ] }, "time": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "text": { "example": "# README", "type": "string", "pattern": "^[\\s\\S]+$" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } }, "required": [ "text" ] }, "FHIR.R5.Datatypes.CodeableConcept": { "type": "object", "properties": { "coding": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Coding" } }, "text": { "type": [ "string", "null" ] } } }, "FHIR.R5.Datatypes.CodeableReference": { "type": "object", "properties": { "concept": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "reference": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Coding": { "type": "object", "properties": { "system": { "example": "http://loinc.org", "type": [ "string", "null" ], "pattern": "\\S*" }, "version": { "type": [ "string", "null" ] }, "code": { "example": "AAA-000", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "display": { "type": [ "string", "null" ] }, "userSelected": { "type": [ "boolean", "null" ] } } }, "FHIR.R5.Datatypes.Duration": { "type": "object", "properties": { "value": { "type": [ "number", "null" ] }, "comparator": { "example": "=", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "unit": { "type": [ "string", "null" ] }, "system": { "example": "http://loinc.org", "type": [ "string", "null" ], "pattern": "\\S*" }, "code": { "example": "ABC", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Identifier": { "type": "object", "properties": { "use": { "example": "2986-8", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "codeableConcept": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "system": { "example": "http://loinc.org", "type": [ "string", "null" ], "pattern": "\\S*" }, "value": { "type": [ "string", "null" ] }, "period": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Period" }, { "type": "null" } ] }, "reference": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Period": { "type": "object", "properties": { "start": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "end": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" } } }, "FHIR.R5.Datatypes.Quantity": { "type": "object", "properties": { "value": { "type": [ "number", "null" ] }, "comparator": { "example": "=", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "unit": { "type": [ "string", "null" ] }, "system": { "example": "http://loinc.org", "type": [ "string", "null" ], "pattern": "\\S*" }, "code": { "example": "ABC", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Range": { "type": "object", "properties": { "low": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Quantity" }, { "type": "null" } ] }, "high": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Quantity" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Ratio": { "type": "object", "properties": { "numerator": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Quantity" }, { "type": "null" } ] }, "denominator": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Quantity" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Reference": { "type": "object", "properties": { "reference": { "type": [ "string", "null" ] }, "type": { "example": "observations/1", "type": [ "string", "null" ], "pattern": "\\S*" }, "identifier": { "type": "object" }, "display": { "type": [ "string", "null" ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Timing": { "type": "object", "properties": { "event": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "repeat": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Timing.Repeat" }, { "type": "null" } ] }, "code": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Datatypes.Timing.Repeat": { "type": "object", "properties": { "boundsDuration": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Duration" }, { "type": "null" } ] }, "boundsRange": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Range" }, { "type": "null" } ] }, "boundsPeriod": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Period" }, { "type": "null" } ] }, "count": { "minimum": 0, "exclusiveMinimum": 0, "type": [ "integer", "null" ] }, "countMax": { "minimum": 0, "exclusiveMinimum": 0, "type": [ "integer", "null" ] }, "duration": { "type": [ "number", "null" ] }, "durationMax": { "type": [ "number", "null" ] }, "durationUnit": { "example": "min", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "frequency": { "minimum": 0, "exclusiveMinimum": 0, "type": [ "integer", "null" ] }, "frequencyMax": { "minimum": 0, "exclusiveMinimum": 0, "type": [ "integer", "null" ] }, "period": { "type": [ "number", "null" ] }, "periodMax": { "type": [ "number", "null" ] }, "periodUnit": { "example": "min", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "dayOfWeek": { "example": "mon", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "timeOfDay": { "example": "12:00:00", "type": [ "string", "null" ], "format": "date-time" }, "when": { "example": "HS", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "offset": { "type": [ "integer", "null" ] } } }, "FHIR.R5.DiagnosticReport": { "type": "object", "properties": { "resourceType": { "default": "DiagnosticReport", "type": "string" }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Identifier" } }, "basedOn": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "status": { "default": "final", "type": "string", "pattern": "[^\\s]+( [^\\s]+)*" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" } }, "code": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, "subject": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "encounter": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "effectiveDateTime": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "effectivePeriod": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Period" }, { "type": "null" } ] }, "issued": { "type": [ "string", "null" ], "format": "date-time" }, "performer": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "resultsInterpreter": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "specimen": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "note": { "type": "array", "items": { "type": "object" } }, "study": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "supportingInfo": { "type": "array", "items": { "type": "object" } }, "media": { "type": "array", "items": { "type": "object" } }, "composition": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "conclusion": { "example": "# README", "type": [ "string", "null" ], "pattern": "^[\\s\\S]+$" }, "conclusionCode": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" } }, "presentedForm": { "type": "array", "items": { "type": "object" } }, "text": { "type": "object" }, "contained": { "type": "array", "items": { "type": "object" } }, "extension": { "type": "array", "items": { "type": "object" } }, "modifierExtension": { "type": "array", "items": { "type": "object" } }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Resources.Meta" } }, "implicitRules": { "type": [ "string", "null" ], "pattern": "\\S*" }, "language": { "example": "de", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" } } }, "FHIR.R5.Observation": { "type": "object", "properties": { "resourceType": { "default": "Observation", "type": "string" }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Identifier" } }, "instantiatesCanonical": { "example": "http://orders.probatix.de/fhir/r5/observation_definitions/", "type": [ "string", "null" ], "pattern": "\\S*" }, "instantiatesReference": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "basedOn": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "triggeredBy": { "type": "array", "items": { "type": "object" } }, "partOf": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "status": { "default": "final", "example": "final", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" } }, "code": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "focus": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "encounter": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "effectiveDateTime": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "effectivePeriod": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Period" }, { "type": "null" } ] }, "effectiveTiming": { "type": "object" }, "effectiveInstant": { "type": [ "string", "null" ], "format": "date-time" }, "issued": { "type": [ "string", "null" ], "format": "date-time" }, "performer": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "valueQuantity": { "type": "object" }, "valueCodeableConcept": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "valueString": { "type": [ "string", "null" ] }, "valueBoolean": { "type": [ "boolean", "null" ] }, "valueInteger": { "type": [ "integer", "null" ] }, "valueRange": { "type": "object" }, "valueRatio": { "type": "object" }, "valueSampledData": { "type": "object" }, "valueTime": { "example": "12:00:00", "type": [ "string", "null" ], "format": "date-time" }, "valueDateTime": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "valuePeriod": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Period" }, { "type": "null" } ] }, "valueAttachment": { "type": "object" }, "valueReference": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "dataAbsentReason": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "interpretation": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" } }, "note": { "type": "array", "items": { "type": "object" } }, "bodySite": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "bodyStructure": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "method": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "specimen": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "device": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "referenceRange": { "type": "array", "items": { "type": "object" } }, "hasMember": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "derivedFrom": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "component": { "type": "array", "items": { "type": "object" } }, "text": { "type": "object" }, "contained": { "type": "array", "items": { "type": "object" } }, "extension": { "type": "array", "items": { "type": "object" } }, "modifierExtension": { "type": "array", "items": { "type": "object" } }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Resources.Meta" } }, "implicitRules": { "type": [ "string", "null" ], "pattern": "\\S*" }, "language": { "example": "de", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" } } }, "FHIR.R5.Resources.Meta": { "type": "object", "properties": { "versionId": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "lastUpdated": { "type": [ "string", "null" ], "format": "date-time" }, "source": { "example": "http://loinc.org", "type": [ "string", "null" ], "pattern": "\\S*" }, "profile": { "type": [ "array", "null" ], "items": { "type": "string" } }, "security": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Coding" } }, "tag": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Coding" } }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Resources.ServiceRequest.OrderDetail": { "type": "object", "properties": { "parameterFocus": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableReference" }, { "type": "null" } ] }, "parameter": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Resources.ServiceRequest.OrderDetail.Parameter" } }, "modifierExtension": { "type": [ "array", "null" ], "items": {} }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Resources.ServiceRequest.OrderDetail.Parameter": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, "valueQuantity": { "type": "object" }, "valueRatio": { "type": "object" }, "valueRange": { "type": "object" }, "valueBoolean": { "type": [ "boolean", "null" ] }, "valueCodeableConcept": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "valueString": { "type": [ "string", "null" ] }, "valuePeriod": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Period" }, { "type": "null" } ] }, "modifierExtension": { "type": [ "array", "null" ], "items": {} }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.Resources.ServiceRequest.PatientInstruction": { "type": "object", "properties": { "instructionMarkdown": { "example": "# README", "type": [ "string", "null" ], "pattern": "^[\\s\\S]+$" }, "instructionReference": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "modifierExtension": { "type": [ "array", "null" ], "items": {} }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "extension": { "type": "array", "items": { "type": "object" } } } }, "FHIR.R5.ServiceRequest": { "type": "object", "properties": { "resourceType": { "default": "ServiceRequest", "type": "string" }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Identifier" } }, "instantiatesCanonical": { "type": [ "array", "null" ], "items": { "type": "string" } }, "instantiatesUri": { "type": [ "array", "null" ], "items": { "type": "string" } }, "basedOn": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "replaces": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "requisition": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Identifier" }, { "type": "null" } ] }, "status": { "default": "draft", "type": "string", "enum": [ "draft", "active", "on-hold", "revoked", "completed", "entered-in-error", "unknown" ] }, "intent": { "default": "proposal", "type": "string" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" } }, "priority": { "example": "asap", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "doNotPerform": { "default": false, "type": "boolean" }, "code": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableReference" }, { "type": "null" } ] }, "orderDetail": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Resources.ServiceRequest.OrderDetail" } }, "quantityQuantity": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Quantity" }, { "type": "null" } ] }, "quantityRatio": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Ratio" }, { "type": "null" } ] }, "quantityRange": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Range" }, { "type": "null" } ] }, "subject": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, "focus": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "encounter": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "occurrenceDateTime": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "occurrencePeriod": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Period" }, { "type": "null" } ] }, "occurrenceTiming": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Timing" }, { "type": "null" } ] }, "asNeededBoolean": { "type": [ "boolean", "null" ] }, "asNeededCodeableConcept": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "authoredOn": { "example": "2025-01-09T13:48:29+01:00", "type": [ "string", "null" ], "format": "date-time" }, "requester": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "performerType": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" }, { "type": "null" } ] }, "performer": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "location": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableReference" } }, "reason": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableReference" } }, "insurance": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "supportingInfo": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableReference" } }, "specimen": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "bodySite": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.CodeableConcept" } }, "bodyStructure": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" }, { "type": "null" } ] }, "note": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Annotation" } }, "patientInstruction": { "anyOf": [ { "$ref": "#/components/schemas/FHIR.R5.Resources.ServiceRequest.PatientInstruction" }, { "type": "null" } ] }, "relevantHistory": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Datatypes.Reference" } }, "text": { "type": "object" }, "contained": { "type": "array", "items": { "type": "object" } }, "extension": { "type": "array", "items": { "type": "object" } }, "modifierExtension": { "type": "array", "items": { "type": "object" } }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "pattern": "[A-Za-z0-9\\-\\.]{1,64}" }, "meta": { "type": "array", "items": { "$ref": "#/components/schemas/FHIR.R5.Resources.Meta" } }, "implicitRules": { "type": [ "string", "null" ], "pattern": "\\S*" }, "language": { "example": "de", "type": [ "string", "null" ], "pattern": "[^\\s]+( [^\\s]+)*" }, "pKV": { "readOnly": true, "type": "boolean" }, "healthInsuranceCompanyName": { "readOnly": true, "type": [ "string", "null" ] }, "healthInsuranceSubscriberId": { "readOnly": true, "type": [ "string", "null" ] } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "RangeInterval": { "type": "object", "required": [ "label" ], "properties": { "label": { "description": "Optional human-readable label for the interval, for example `negative` or `positive`.", "example": "negative", "type": "string" }, "lower": { "description": "Optional lower boundary of the interval. Lower boundaries use `>` or `>=` operators.", "anyOf": [ { "$ref": "#/components/schemas/Boundary" }, { "type": "null" } ] }, "upper": { "description": "Optional upper boundary of the interval. Upper boundaries use `<` or `<=` operators.", "example": { "operator": "<=", "value": 5.5 }, "anyOf": [ { "$ref": "#/components/schemas/Boundary" }, { "type": "null" } ] } } }, "Boundary": { "type": "object", "required": [ "operator" ], "properties": { "operator": { "description": "Comparison operator for the boundary. Lower boundaries use `>` or `>=`; upper boundaries use `<` or `<=`.", "example": "<=", "type": "string", "enum": [ ">", ">=", "<", "<=" ] }, "value": { "description": "Boundary value used together with the operator.", "example": 5.5, "type": [ "number", "null" ] } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "apiKey": { "type": "apiKey", "description": "", "name": "X-API-TOKEN", "in": "header" } } }, "security": [], "tags": [ { "name": "Service Requests", "description": "Resource 'Service Requests' operations." }, { "name": "Diagnostic Reports", "description": "Resource 'Diagnostic Reports' operations." }, { "name": "Observations", "description": "Resource 'Observations' operations." } ], "webhooks": {} }