{ "openapi": "3.2.0", "info": { "title": "Probatix Diagnostics API v1", "description": "## Filtering\n\nCollection endpoints support query parameters for filtering and sorting results.\n\n- Some filters are single-value parameters: one parameter carries one value.\n- Some filters are repeatable parameters: the same parameter name is sent with `[]` and can be provided multiple times.\n- Repeated values for repeatable filters are OR-combined.\n\n## Single-Value Filters\n\nUse these filters once per field.\n\n> If the same singular-value filter is passed multiple times, the last value is generally the one that is applied.\n> However, this is not considered a supported use case and no guarantees are made about that behavior.\n\n#### DateTime Filter\n\nUsed for range filtering on datetime fields with operators such as `gt`, `gte`, `lt`, and `lte`.\n\nAccepted datetime input formats therefore include:\n\n- Full ISO 8601 / RFC 3339 timestamps such as `2026-01-01T00:00:00+00:00` or `2026-01-01T00:00:00Z`\n- Date-only values such as `2026-02-01`\n- Relative datetime expressions such as `-30 minutes`, `yesterday`, or `first day of this month`\n\nPrefer timestamps with an explicit timezone offset or `Z` to avoid ambiguity.\nIf no timezone is included, the server default timezone (`Europe/Berlin`) is used.\n\nExamples:\n\n- `createdAt[gt]=2026-01-01T00:00:00+00:00`\n- `createdAt[gte]=-30 minutes`\n- `createdAt[lte]=2026-01-31T23:59:59+00:00`\n- `activatedAt[gte]=2026-01-01T00:00:00Z`\n- `labIntakeAt[lt]=2026-02-01`\n\n#### Exact Filter\n\nUsed for exact matching on scalar values.\n\nExamples:\n\n- `patient.dateOfBirth[]=1994-01-15`\n- `patient.gender[]=F&patient.gender[]=D`\n- `diagnosticOrder[]=00112233-4455-6677-8899-aabbccddeeff`\n\n#### Exists Filter\n\nUsed to filter for resources where a property is present or absent. This is especially useful for nullable properties.\n\nExamples:\n\n- `exists[activatedAt]=true`\n- `exists[labIntakeAt]=false`\n- `exists[unit]=true`\n\n#### Free Text Query Filter\n\nUsed for whitespace-tokenized free-text search across a predefined group of fields behind one parameter.\n\nThe input is a single string, for example `Jane Doe`. It is split into tokens like `Jane` and `Doe`.\nEach token must match at least one configured field, so the token groups are AND-combined.\n\n`freeTextQuery[...]` is a single-string multi-field search parameter.\nUnlike repeatable filters, this parameter is not sent as `[]`.\n\nIt is more restrictive than `query[...][]` because the individual words should all be present\nsomewhere across the configured fields. For example:\n\n- `freeTextQuery[name]=Jane Doe`\n\n#### Sort Filter\n\nUsed to control result ordering.\n\nExamples:\n\n- `sort[createdAt]=asc`\n- `sort[createdAt]=desc`\n\n## Repeatable Filters\n\nThese filters accept repeated values. Multiple values for the same filter are OR-combined.\n\n#### Search Filter\n\nUsed for case-insensitive partial matching on a single string field.\n\nExamples:\n\n- `search[patient.firstName][]=Jane`\n- `search[patient.lastName][]=Doe&search[patient.lastName][]=Miller`\n- `search[patient.email][]=example.com`\n\n`search[...][]` targets one specific field per parameter. For example:\n\n- `search[patient.firstName][]=Jane&search[patient.lastName][]=Doe`\n\nThis is the most explicit option because each field is filtered independently.\n\n#### Query Filter\n\nUsed for case-insensitive partial matching across a predefined group of fields behind one parameter.\n\nMultiple values for the same `query[...][]` parameter are OR-combined.\nEach value is checked against any of the fields configured for that query profile.\n\n`query[...][]` targets a predefined group of fields behind one parameter. For example:\n\n- `query[name][]=Jane&query[name][]=Doe`\n- `query[onSiteBooking][]=ZKLAB`\n\nUnlike `freeTextQuery[...]`, values are not tokenized automatically.\n`query[name][]=Jane Doe` searches for the full string `Jane Doe` as one value.\n\n## JSON Filters\n\nThese filters target scalar values inside JSON object fields.\nDot-separated paths such as `metadata.reference` address nested object keys.\n\n`json_exact` and `json_search` are rendered as `deepObject` query parameters in OpenAPI\nso examples remain faithful to the real request shape.\n\n#### JSON Exact Filter\n\nUsed for exact matching on scalar values inside JSON object fields using dot-separated paths.\n\nOpenAPI example shape:\n\n- `json_exact[metadata.id][]=externalId&json_exact[metadata.id][]=anotherId`\n\n#### JSON Exists Filter\n\nUsed to filter JSON object fields by whether a dot-separated path exists and the value is not JSON `null`.\n\nExamples:\n\n- `json_exists[metadata.yourReference1]=true`\n- `json_exists[metadata.partnerReference]=false`\n\n#### JSON Search Filter\n\nUsed for case-insensitive partial matching on scalar values inside JSON object fields using dot-separated paths.\n\nOpenAPI example shape:\n\n- `json_search[metadata.id][]=externalId&json_search[metadata.id][]=anotherId`", "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": { "/v1/diagnostic_orders": { "get": { "operationId": "api_v1diagnostic_orders_get_collection", "tags": [ "Diagnostic Orders" ], "responses": { "200": { "description": "DiagnosticOrder collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticOrder" } } }, "application/ld+json": { "schema": { "type": "object", "description": "DiagnosticOrder.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticOrder.jsonld" } } } } ] } } } }, "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 DiagnosticOrder resources.", "description": "Retrieves the collection of DiagnosticOrder 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 }, { "name": "createdAt[gt]", "in": "query", "description": "Return resources with `createdAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "Return resources with `createdAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "Return resources with `createdAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "Return resources with `createdAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "diagnosticOrder[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "diagnosticTest[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "json_exact", "in": "query", "description": "Exact match on JSON scalar values at dot-separated object paths. Supported roots: metadata. Example values: json_exact[metadata.id][]=externalId&json_exact[metadata.id][]=anotherId.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "style": "deepObject", "explode": true, "example": { "metadata.yourReference1": [ "externalId", "anotherId" ] } }, { "name": "json_exists[metadata.yourReference1]", "in": "query", "description": "Filter by whether a dot-separated JSON object path exists and is not null. Supported roots: metadata. Examples: json_exists[metadata.yourReference1]=true and json_exists[metadata.yourReference1]=false.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": true }, { "name": "json_search", "in": "query", "description": "Case-insensitive partial match on JSON scalar values at dot-separated object paths. Supported roots: metadata. Example values: json_search[metadata.id][]=externalId&json_search[metadata.id][]=anotherId.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "style": "deepObject", "explode": true, "example": { "metadata.yourReference1": [ "externalId", "anotherId" ] } }, { "name": "sort[createdAt]", "in": "query", "description": "DiagnosticOrder sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[createdAt][]", "in": "query", "description": "DiagnosticOrder sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "sort[id]", "in": "query", "description": "DiagnosticOrder sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "DiagnosticOrder sort[id]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] }, "post": { "operationId": "api_v1diagnostic_orders_post", "tags": [ "Diagnostic Orders" ], "responses": { "201": { "description": "DiagnosticOrderInput resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrderInput.DiagnosticOrder" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrderInput.DiagnosticOrder.jsonld" } } }, "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 DiagnosticOrderInput resource.", "description": "Creates a DiagnosticOrderInput 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 DiagnosticOrderInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrderInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrderInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_orders/{id}": { "get": { "operationId": "api_v1diagnostic_orders_id_get", "tags": [ "Diagnostic Orders" ], "responses": { "200": { "description": "DiagnosticOrder resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrder" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticOrder.jsonld" } } } }, "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 DiagnosticOrder resource.", "description": "Retrieves a DiagnosticOrder 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": "DiagnosticOrder identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_products": { "get": { "operationId": "api_v1diagnostic_products_get_collection", "tags": [ "Diagnostic Products" ], "responses": { "200": { "description": "DiagnosticProduct collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticProduct" } } }, "application/ld+json": { "schema": { "type": "object", "description": "DiagnosticProduct.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticProduct.jsonld" } } } } ] } } } }, "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 DiagnosticProduct resources.", "description": "Retrieves the collection of DiagnosticProduct 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 }, { "name": "biomarkerPanel[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "countryCode[]", "in": "query", "description": "Exact match on one or more ISO 3166-1 alpha-2 country codes.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$", "minLength": 2, "maxLength": 2 } }, "style": "form", "explode": true, "example": "DE" }, { "name": "createdAt[gt]", "in": "query", "description": "Return resources with `createdAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "Return resources with `createdAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "Return resources with `createdAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "Return resources with `createdAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "diagnosticProduct[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "sort[createdAt]", "in": "query", "description": "DiagnosticProduct sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[createdAt][]", "in": "query", "description": "DiagnosticProduct sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "sort[id]", "in": "query", "description": "DiagnosticProduct sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "DiagnosticProduct sort[id]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "status[]", "in": "query", "description": "DiagnosticProduct status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "active", "archived" ] } }, "style": "form", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_products/{id}": { "get": { "operationId": "api_v1diagnostic_products_id_get", "tags": [ "Diagnostic Products" ], "responses": { "200": { "description": "DiagnosticProduct resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticProduct" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticProduct.jsonld" } } } }, "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 DiagnosticProduct resource.", "description": "Retrieves a DiagnosticProduct 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": "DiagnosticProduct identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_tests": { "get": { "operationId": "api_v1diagnostic_tests_get_collection", "tags": [ "Diagnostic Tests" ], "responses": { "200": { "description": "DiagnosticTest collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticTest" } } }, "application/ld+json": { "schema": { "type": "object", "description": "DiagnosticTest.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticTest.jsonld" } } } } ] } } } }, "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 DiagnosticTest resources.", "description": "Retrieves the collection of DiagnosticTest 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 }, { "name": "activatedAt[gt]", "in": "query", "description": "Return resources with `activatedAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "activatedAt[gte]", "in": "query", "description": "Return resources with `activatedAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "activatedAt[lt]", "in": "query", "description": "Return resources with `activatedAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "activatedAt[lte]", "in": "query", "description": "Return resources with `activatedAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[gt]", "in": "query", "description": "Return resources with `createdAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "Return resources with `createdAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "Return resources with `createdAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "Return resources with `createdAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "diagnosticOrder[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "diagnosticProduct[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "diagnosticTest[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "exists[activatedAt]", "in": "query", "description": "Filter by whether the activated at exists.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false }, { "name": "exists[fulfilledAt]", "in": "query", "description": "Filter by whether the fulfilled at exists.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false }, { "name": "exists[labIntakeAt]", "in": "query", "description": "Filter by whether the lab intake at exists.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false }, { "name": "labIntakeAt[gt]", "in": "query", "description": "Return resources with `labIntakeAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "labIntakeAt[gte]", "in": "query", "description": "Return resources with `labIntakeAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "labIntakeAt[lt]", "in": "query", "description": "Return resources with `labIntakeAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "labIntakeAt[lte]", "in": "query", "description": "Return resources with `labIntakeAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "patient.dateOfBirth[]", "in": "query", "description": "Exact match on the patient date of birth.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "format": "date" } }, "style": "form", "explode": true }, { "name": "patient.gender[]", "in": "query", "description": "Exact match on one or more patient gender values.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "M", "F", "D", "X" ] } }, "style": "form", "explode": true }, { "name": "search[patient.email][]", "in": "query", "description": "Case-insensitive partial match on the patient email.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "format": "email" } }, "style": "form", "explode": true }, { "name": "search[patient.firstName][]", "in": "query", "description": "Case-insensitive partial match on the patient first name.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "search[patient.lastName][]", "in": "query", "description": "Case-insensitive partial match on the patient last name.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "sort[createdAt]", "in": "query", "description": "DiagnosticTest sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[createdAt][]", "in": "query", "description": "DiagnosticTest sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "sort[id]", "in": "query", "description": "DiagnosticTest sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "DiagnosticTest sort[id]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "testResult[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_tests/{id}": { "get": { "operationId": "api_v1diagnostic_tests_id_get", "tags": [ "Diagnostic Tests" ], "responses": { "200": { "description": "DiagnosticTest resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTest.jsonld" } } } }, "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 DiagnosticTest resource.", "description": "Retrieves a DiagnosticTest 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": "DiagnosticTest identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_tests/{id}/cancel": { "post": { "operationId": "api_v1diagnostic_tests_idcancel_post", "tags": [ "Diagnostic Tests" ], "responses": { "200": { "description": "DiagnosticTestCancelInput resource created", "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": "Cancel a diagnostic test", "description": "Cancels an eligible DiagnosticTest.", "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": "DiagnosticTestCancelInput identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new DiagnosticTestCancelInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestCancelInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestCancelInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_tests/{id}/replace": { "post": { "operationId": "api_v1diagnostic_tests_idreplace_post", "tags": [ "Diagnostic Tests" ], "responses": { "200": { "description": "DiagnosticTestReplaceInput resource created", "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": "Replace a diagnostic test", "description": "Creates a replacement DiagnosticTest linked to the original test.", "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": "DiagnosticTestReplaceInput identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new DiagnosticTestReplaceInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestReplaceInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestReplaceInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/documents/{id}/download": { "get": { "operationId": "api_v1documents_iddownload_get", "tags": [ "Documents" ], "responses": { "200": { "description": "Binary document download", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary", "description": "Binary file contents of the requested document. Inspect the `Content-Type` response header for the actual media type, for example `application/pdf`." } } }, "headers": { "Content-Type": { "in": "header", "description": "Actual MIME type of the returned document.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "application/pdf" }, "Content-Disposition": { "in": "header", "description": "Attachment header including the download filename.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, "allowReserved": false, "example": "attachment; filename=\"example.pdf\"" } } }, "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": "Download a document file", "description": "Returns the document as a binary file download. The response body is raw binary data, not JSON. Content negotiation is not used for this endpoint, and the `Accept` header is ignored. Use the response `Content-Type` and `Content-Disposition` headers to determine the actual file type and filename.", "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": "DocumentDownload identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_tests/{id}/activate": { "post": { "operationId": "api_v1diagnostic_tests_idactivate_post", "tags": [ "External Activation" ], "responses": { "200": { "description": "DiagnosticTestActivateInput resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestActivateInput.DiagnosticTest" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestActivateInput.DiagnosticTest.jsonld" } } }, "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": "Activate a diagnostic test", "description": "Activates the DiagnosticTest. A specimen code is required when it was not provided during external fulfillment only. If the test already has a specimen, omit this field. If provided, the code must match the existing specimen.", "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": "DiagnosticTestActivateInput identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new DiagnosticTestActivateInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestActivateInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestActivateInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_orders/{id}/shipment_tracking": { "post": { "operationId": "api_v1diagnostic_orders_idshipment_tracking_post", "tags": [ "External Fulfillment" ], "responses": { "200": { "description": "ShipmentTrackingInput resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput.DiagnosticOrder" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput.DiagnosticOrder.jsonld" } } }, "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": "Create or update outbound shipment tracking for a diagnostic order", "description": "Creates or updates shipment tracking for the FulfillmentCenter -> Customer shipment of the DiagnosticOrder.", "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": "ShipmentTrackingInput identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new ShipmentTrackingInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_tests/{id}/shipment_tracking": { "post": { "operationId": "api_v1diagnostic_tests_idshipment_tracking_post", "tags": [ "External Fulfillment" ], "responses": { "200": { "description": "ShipmentTrackingInput resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput.DiagnosticTest" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput.DiagnosticTest.jsonld" } } }, "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": "Create or update inbound shipment tracking for a diagnostic test", "description": "Creates or updates shipment tracking for the Customer -> Lab shipment of the DiagnosticTest.", "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": "ShipmentTrackingInput identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new ShipmentTrackingInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/diagnostic_tests/{id}/specimens": { "post": { "operationId": "api_v1diagnostic_tests_idspecimens_post", "tags": [ "External Fulfillment" ], "responses": { "200": { "description": "DiagnosticTestSpecimenInput resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestSpecimenInput.DiagnosticTest" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestSpecimenInput.DiagnosticTest.jsonld" } } }, "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": "Add a specimen to a diagnostic test", "description": "Creates or updates a specimen entry for the DiagnosticTest using the external specimen code. This endpoint only stores the specimen reference and does not activate the test.", "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": "DiagnosticTestSpecimenInput identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The new DiagnosticTestSpecimenInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestSpecimenInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTestSpecimenInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/gdpr-erasure": { "post": { "operationId": "api_v1gdpr-erasure_post", "tags": [ "GDPR Erasure" ], "responses": { "204": { "description": "GdprErasure resource created", "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": "Request GDPR erasure by email address", "description": "Request GDPR erasure by email address", "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 GdprErasure resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GdprErasure" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/GdprErasure" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/observations": { "get": { "operationId": "api_v1observations_get_collection", "tags": [ "Observations" ], "responses": { "200": { "description": "Observation collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Observation" } } }, "application/ld+json": { "schema": { "type": "object", "description": "Observation.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Observation.jsonld" } } } } ] } } } }, "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 Observation resources.", "description": "Retrieves the collection of 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 }, { "name": "createdAt[gt]", "in": "query", "description": "Return resources with `createdAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "Return resources with `createdAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "Return resources with `createdAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "Return resources with `createdAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "exists[interpretation]", "in": "query", "description": "Filter by whether the interpretation exists.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false }, { "name": "exists[unit]", "in": "query", "description": "Filter by whether the unit exists.", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false }, { "name": "observation[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "sort[id]", "in": "query", "description": "Observation sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "Observation sort[id]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "sort[loinc]", "in": "query", "description": "Observation sort[loinc]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[loinc][]", "in": "query", "description": "Observation sort[loinc]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "testResult[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/observations/{id}": { "get": { "operationId": "api_v1observations_id_get", "tags": [ "Observations" ], "responses": { "200": { "description": "Observation resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/Observation.jsonld" } } } }, "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 Observation resource.", "description": "Retrieves a 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": "Observation identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/test_results": { "get": { "operationId": "api_v1test_results_get_collection", "tags": [ "Test Results" ], "responses": { "200": { "description": "TestResult collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TestResult" } } }, "application/ld+json": { "schema": { "type": "object", "description": "TestResult.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/TestResult.jsonld" } } } } ] } } } }, "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 TestResult resources.", "description": "Retrieves the collection of TestResult 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 }, { "name": "createdAt[gt]", "in": "query", "description": "Return resources with `createdAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[gte]", "in": "query", "description": "Return resources with `createdAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lt]", "in": "query", "description": "Return resources with `createdAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "createdAt[lte]", "in": "query", "description": "Return resources with `createdAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "diagnosticTest[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "observation[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "sort[createdAt]", "in": "query", "description": "TestResult sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[createdAt][]", "in": "query", "description": "TestResult sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "sort[id]", "in": "query", "description": "TestResult sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "TestResult sort[id]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "testResult[]", "in": "query", "description": "Filter by identifier, IRI, or canonical identifier.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } }, "/v1/test_results/{id}": { "get": { "operationId": "api_v1test_results_id_get", "tags": [ "Test Results" ], "responses": { "200": { "description": "TestResult resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestResult" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/TestResult.jsonld" } } } }, "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 TestResult resource.", "description": "Retrieves a TestResult 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": "TestResult identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_Diagnostics_v1" ] } } }, "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" }, "DiagnosticOrder": { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticTests": { "description": "IRIs of the diagnostic tests that belong to this order.", "example": [ "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "createdAt": { "description": "Timestamp when the order was created.", "type": "string", "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when the outbound shipment was handed over.", "example": "2026-05-04T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "shipmentTracking": { "description": "Tracking details for the outbound shipment, when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "shippingAddress": { "description": "Shipping address stored for the order.", "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } }, "DiagnosticOrder.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticTests": { "description": "IRIs of the diagnostic tests that belong to this order.", "example": [ "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "createdAt": { "description": "Timestamp when the order was created.", "type": "string", "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when the outbound shipment was handed over.", "example": "2026-05-04T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "shipmentTracking": { "description": "Tracking details for the outbound shipment, when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "shippingAddress": { "description": "Shipping address stored for the order.", "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput.jsonld" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } } ] }, "DiagnosticOrderInput": { "type": "object", "required": [ "productIds", "patient", "shippingAddress" ], "properties": { "productIds": { "minItems": 1, "description": "Identifiers of the DiagnosticProducts to order. Each entry may be a UUID, a DiagnosticProduct IRI, or a canonical ID. Provide at least one product ID.", "example": [ "1f09de62-6e45-6970-afda-7b07372bb3bd" ], "type": "array", "items": { "type": "string" } }, "patient": { "$ref": "#/components/schemas/PatientInput" }, "shippingAddress": { "$ref": "#/components/schemas/FullAddressInput" }, "metadata": { "maxItems": 10, "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } }, "DiagnosticOrderInput.DiagnosticOrder": { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticTests": { "description": "IRIs of the diagnostic tests that belong to this order.", "example": [ "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "createdAt": { "description": "Timestamp when the order was created.", "type": "string", "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when the outbound shipment was handed over.", "example": "2026-05-04T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "shipmentTracking": { "description": "Tracking details for the outbound shipment, when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "shippingAddress": { "description": "Shipping address stored for the order.", "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } }, "DiagnosticOrderInput.DiagnosticOrder.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticTests": { "description": "IRIs of the diagnostic tests that belong to this order.", "example": [ "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "createdAt": { "description": "Timestamp when the order was created.", "type": "string", "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when the outbound shipment was handed over.", "example": "2026-05-04T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "shipmentTracking": { "description": "Tracking details for the outbound shipment, when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "shippingAddress": { "description": "Shipping address stored for the order.", "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput.jsonld" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } } ] }, "DiagnosticProduct": { "type": "object", "required": [ "id", "name", "countryCode", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "description": "Translated display name. The `accept-language` header is used to select the translation when available. German (`de`) is used as the fallback. The value may still be a translation key if no translation exists yet.", "type": "string" }, "countryCode": { "description": "Country in which the product is available.", "example": "DE", "type": "string", "pattern": "^[A-Z]{2}$", "minLength": 2, "maxLength": 2 }, "createdAt": { "type": "string", "format": "date-time" }, "status": { "description": "Current DiagnosticProduct status.", "example": "active", "type": "string", "enum": [ "active", "archived" ] }, "evaluationRequirements": { "description": "Information required from the patient before the diagnostic product can be evaluated.", "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "MENSTRUAL_PHASE" ] } } } }, "DiagnosticProduct.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "name", "countryCode", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "description": "Translated display name. The `accept-language` header is used to select the translation when available. German (`de`) is used as the fallback. The value may still be a translation key if no translation exists yet.", "type": "string" }, "countryCode": { "description": "Country in which the product is available.", "example": "DE", "type": "string", "pattern": "^[A-Z]{2}$", "minLength": 2, "maxLength": 2 }, "createdAt": { "type": "string", "format": "date-time" }, "status": { "description": "Current DiagnosticProduct status.", "example": "active", "type": "string", "enum": [ "active", "archived" ] }, "evaluationRequirements": { "description": "Information required from the patient before the diagnostic product can be evaluated.", "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "MENSTRUAL_PHASE" ] } } } } ] }, "DiagnosticTest": { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } }, "DiagnosticTest.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient.jsonld" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen.jsonld" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } } ] }, "DiagnosticTestActivateInput": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "specimenCode": { "maxLength": 255, "description": "Laboratory specimen code or sample identifier.", "example": "ABC-123456", "type": [ "string", "null" ] }, "collectionDate": { "description": "Date when the specimen was collected.", "example": "2026-05-04", "type": "string", "format": "date" }, "collectionTime": { "description": "Time of day when the specimen was collected.", "example": "13:50:00", "type": "string", "pattern": "^\\d{2}:\\d{2}:\\d{2}$" }, "menstrualPhaseAtCollection": { "description": "Optional menstrual phase reported at collection time, when applicable.", "example": "luteal", "type": [ "string", "null" ], "enum": [ "follikel", "ovulation", "luteal", "menopause", null ] }, "gender": { "description": "Patient gender.", "example": "F", "type": "string", "enum": [ "M", "F", "D", "X" ] }, "dateOfBirth": { "description": "Patient date of birth.", "example": "1994-01-15", "type": "string", "format": "date" }, "healthInsuranceDetails": { "description": "Health insurance details, when applicable for the ordered DiagnosticProduct.", "anyOf": [ { "$ref": "#/components/schemas/HealthInsuranceDetails" }, { "type": "null" } ] } }, "required": [ "collectionDate", "collectionTime", "gender", "dateOfBirth" ] }, "DiagnosticTestActivateInput.DiagnosticTest": { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } }, "DiagnosticTestActivateInput.DiagnosticTest.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient.jsonld" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen.jsonld" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } } ] }, "DiagnosticTestCancelInput": { "type": "object", "properties": { "cancellationReason": { "description": "Optional reason for cancelling the diagnostic test.", "example": "patient_request", "type": [ "string", "null" ] }, "cancellationReasonComment": { "description": "Optional additional detail about the cancellation.", "example": "Requested before evaluation.", "type": [ "string", "null" ] } } }, "DiagnosticTestReplaceInput": { "type": "object", "properties": { "cancellationReason": { "description": "Optional reason for replacing the diagnostic test.", "example": "damaged_kit", "type": [ "string", "null" ] }, "cancellationReasonComment": { "description": "Optional additional detail about the replacement.", "example": "Specimen kit was damaged in transit.", "type": [ "string", "null" ] } } }, "DiagnosticTestSpecimenInput": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "specimenCode": { "maxLength": 255, "description": "Laboratory specimen code or sample identifier.", "example": "ABC-123456", "type": "string" } }, "required": [ "specimenCode" ] }, "DiagnosticTestSpecimenInput.DiagnosticTest": { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } }, "DiagnosticTestSpecimenInput.DiagnosticTest.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient.jsonld" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen.jsonld" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } } ] }, "Document": { "type": "object", "required": [ "id", "originalFileName", "downloadPath", "mimeType", "size" ], "properties": { "id": { "example": "00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "uuid" }, "originalFileName": { "example": "example.pdf", "type": "string" }, "downloadPath": { "description": "Relative download path for the binary document.", "example": "/v1/documents/00112233-4455-6677-8899-aabbccddeeff/download", "type": "string", "format": "iri-reference" }, "mimeType": { "example": "application/pdf", "type": "string" }, "size": { "description": "Document size in bytes.", "example": 630, "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" } } }, "Document.jsonld": { "type": "object", "required": [ "id", "originalFileName", "downloadPath", "mimeType", "size" ], "properties": { "id": { "example": "00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "uuid" }, "originalFileName": { "example": "example.pdf", "type": "string" }, "downloadPath": { "description": "Relative download path for the binary document.", "example": "/v1/documents/00112233-4455-6677-8899-aabbccddeeff/download", "type": "string", "format": "iri-reference" }, "mimeType": { "example": "application/pdf", "type": "string" }, "size": { "description": "Document size in bytes.", "example": 630, "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" } } }, "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." }, "FullAddressInput": { "type": "object", "required": [ "address1", "zip", "city", "firstName", "lastName" ], "properties": { "address1": { "example": "Bismarckstraße 10-12", "type": "string" }, "address2": { "example": "6. OG", "type": [ "string", "null" ] }, "zip": { "example": "10625", "type": "string" }, "city": { "example": "Berlin", "type": "string" }, "countryCode": { "default": "DE", "example": "DE", "type": "string" }, "firstName": { "example": "Jane", "type": "string" }, "lastName": { "example": "Doe", "type": "string" }, "id": { "readOnly": true, "type": "string", "format": "uuid" }, "phone": { "example": "030 12345678", "type": [ "string", "null" ] }, "company": { "example": "Probatix Health GmbH", "type": [ "string", "null" ] }, "name": { "example": "Probatix Health GmbH", "type": [ "string", "null" ] } } }, "FullAddressInput.jsonld": { "type": "object", "required": [ "address1", "zip", "city", "firstName", "lastName" ], "properties": { "address1": { "example": "Bismarckstraße 10-12", "type": "string" }, "address2": { "example": "6. OG", "type": [ "string", "null" ] }, "zip": { "example": "10625", "type": "string" }, "city": { "example": "Berlin", "type": "string" }, "countryCode": { "default": "DE", "example": "DE", "type": "string" }, "firstName": { "example": "Jane", "type": "string" }, "lastName": { "example": "Doe", "type": "string" }, "id": { "readOnly": true, "type": "string", "format": "uuid" }, "phone": { "example": "030 12345678", "type": [ "string", "null" ] }, "company": { "example": "Probatix Health GmbH", "type": [ "string", "null" ] }, "name": { "example": "Probatix Health GmbH", "type": [ "string", "null" ] } } }, "GdprErasure": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } } }, "HealthInsuranceDetails": { "type": "object", "properties": { "countryCode": { "example": "DE", "type": [ "string", "null" ] }, "provider": { "example": "Example Insurance", "type": [ "string", "null" ] }, "healthInsuranceTypeDE": { "example": "GKV", "type": [ "string", "null" ], "enum": [ "GKV", "PKV", null ] }, "subscriberIdentifier": { "description": "The insurer assigned ID for the Subscriber.", "type": [ "string", "null" ] } } }, "HealthInsuranceDetails.jsonld": { "type": "object", "properties": { "countryCode": { "example": "DE", "type": [ "string", "null" ] }, "provider": { "example": "Example Insurance", "type": [ "string", "null" ] }, "healthInsuranceTypeDE": { "example": "GKV", "type": [ "string", "null" ], "enum": [ "GKV", "PKV", null ] }, "subscriberIdentifier": { "description": "The insurer assigned ID for the Subscriber.", "type": [ "string", "null" ] } } }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "type": "object", "properties": { "view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "first": { "type": [ "string", "null" ], "format": "iri-reference" }, "last": { "type": [ "string", "null" ], "format": "iri-reference" }, "previous": { "type": [ "string", "null" ], "format": "iri-reference" }, "next": { "type": [ "string", "null" ], "format": "iri-reference" } }, "example": { "@id": "string", "@type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "totalItems": { "type": "integer", "minimum": 0 }, "search": { "type": "object", "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "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" ] }, "Observation": { "type": "object", "required": [ "id", "testResult", "loincNum", "value", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "testResult": { "description": "IRI of the parent test result.", "example": "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "loincNum": { "description": "LOINC code of the reported analyte.", "example": "2570-0", "type": "string" }, "value": { "description": "Raw value as reported by the laboratory. The API exposes it as a string to preserve the original representation. Clients should not assume the value is always safely parseable as a number.", "example": "5.5", "type": "string" }, "unit": { "description": "Measurement unit when the laboratory provides one.", "example": "µg/g", "type": [ "string", "null" ] }, "referenceRange": { "description": "Reference range or interval information supplied for the observation. The structure is interval-based: each interval may define a `lower` and/or `upper` boundary with an operator such as `>`, `>=`, `<`, or `<=`, plus an optional human-readable label such as `negative` or `positive`.", "anyOf": [ { "$ref": "#/components/schemas/ObservationReferenceRange" }, { "type": "null" } ] }, "interpretation": { "description": "Laboratory interpretation, for example positive or negative.", "example": "negative", "type": [ "string", "null" ] }, "labNotes": { "description": "Free-text notes supplied alongside the observation.", "example": [ "Kein Hinweis auf okkultes Blut im Stuhl." ], "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "description": "Timestamp when the observation was created.", "type": "string", "format": "date-time" } } }, "Observation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "testResult", "loincNum", "value", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "testResult": { "description": "IRI of the parent test result.", "example": "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "loincNum": { "description": "LOINC code of the reported analyte.", "example": "2570-0", "type": "string" }, "value": { "description": "Raw value as reported by the laboratory. The API exposes it as a string to preserve the original representation. Clients should not assume the value is always safely parseable as a number.", "example": "5.5", "type": "string" }, "unit": { "description": "Measurement unit when the laboratory provides one.", "example": "µg/g", "type": [ "string", "null" ] }, "referenceRange": { "description": "Reference range or interval information supplied for the observation. The structure is interval-based: each interval may define a `lower` and/or `upper` boundary with an operator such as `>`, `>=`, `<`, or `<=`, plus an optional human-readable label such as `negative` or `positive`.", "anyOf": [ { "$ref": "#/components/schemas/ObservationReferenceRange.jsonld" }, { "type": "null" } ] }, "interpretation": { "description": "Laboratory interpretation, for example positive or negative.", "example": "negative", "type": [ "string", "null" ] }, "labNotes": { "description": "Free-text notes supplied alongside the observation.", "example": [ "Kein Hinweis auf okkultes Blut im Stuhl." ], "type": [ "array", "null" ], "items": { "type": "string" } }, "createdAt": { "description": "Timestamp when the observation was created.", "type": "string", "format": "date-time" } } } ] }, "ObservationReferenceRange": { "type": "object", "required": [ "intervals" ], "properties": { "intervals": { "description": "Reference intervals for the observation. Each interval may define a `lower` and/or `upper` boundary and can optionally provide a human-readable label such as `negative` or `positive`.", "example": [ { "label": "negative", "lower": null, "upper": { "operator": "<=", "value": 5.5 } }, { "label": "positive", "lower": { "operator": ">", "value": 5.5 }, "upper": null } ], "type": "array", "items": { "$ref": "#/components/schemas/RangeInterval" } } } }, "ObservationReferenceRange.jsonld": { "type": "object", "required": [ "intervals" ], "properties": { "intervals": { "description": "Reference intervals for the observation. Each interval may define a `lower` and/or `upper` boundary and can optionally provide a human-readable label such as `negative` or `positive`.", "example": [ { "label": "negative", "lower": null, "upper": { "operator": "<=", "value": 5.5 } }, { "label": "positive", "lower": { "operator": ">", "value": 5.5 }, "upper": null } ], "type": "array", "items": { "$ref": "#/components/schemas/RangeInterval" } } } }, "Patient": { "type": "object", "properties": { "email": { "example": "noreply@probatix.de", "type": "string", "format": "email" }, "firstName": { "example": "Jane", "type": [ "string", "null" ] }, "lastName": { "example": "Doe", "type": [ "string", "null" ] }, "gender": { "default": "X", "type": "string", "enum": [ "M", "F", "D", "X" ] }, "dateOfBirth": { "example": "1994-01-15", "type": "string", "format": "date" }, "healthInsuranceDetails": { "anyOf": [ { "$ref": "#/components/schemas/HealthInsuranceDetails" }, { "type": "null" } ] } } }, "Patient.jsonld": { "type": "object", "properties": { "email": { "example": "noreply@probatix.de", "type": "string", "format": "email" }, "firstName": { "example": "Jane", "type": [ "string", "null" ] }, "lastName": { "example": "Doe", "type": [ "string", "null" ] }, "gender": { "default": "X", "type": "string", "enum": [ "M", "F", "D", "X" ] }, "dateOfBirth": { "example": "1994-01-15", "type": "string", "format": "date" }, "healthInsuranceDetails": { "anyOf": [ { "$ref": "#/components/schemas/HealthInsuranceDetails.jsonld" }, { "type": "null" } ] } } }, "PatientInput": { "type": "object", "required": [ "firstName", "lastName", "email" ], "properties": { "firstName": { "example": "Jane", "type": "string" }, "lastName": { "example": "Doe", "type": "string" }, "email": { "type": "string", "format": "email", "example": "noreply@probatix.de" }, "gender": { "description": "Patient gender. Defaults to `X` (Unknown) when omitted.", "default": "X", "example": "F", "type": "string", "enum": [ "M", "F", "D", "X" ] }, "dateOfBirth": { "description": "Patient date of birth.", "example": "1994-01-15", "type": "string", "format": "date" }, "healthInsuranceDetails": { "description": "Health insurance details, when applicable for the ordered DiagnosticProduct.", "anyOf": [ { "$ref": "#/components/schemas/HealthInsuranceDetails" }, { "type": "null" } ] } } }, "ShipmentTracking": { "type": "object", "required": [ "provider", "createdAt", "updatedAt" ], "properties": { "provider": { "example": "DHL", "type": "string", "enum": [ "DHL", "Swiss Post", "OTHER" ] }, "createdAt": { "description": "Timestamp when the shipment was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp when the shipment was last updated.", "type": "string", "format": "date-time" }, "trackingCode": { "example": "123", "type": [ "string", "null" ] }, "url": { "example": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html?piececode=123", "type": "string", "format": "url" }, "shipmentStatus": { "description": "Normalized shipment status for informational purposes only.", "example": { "terminalStatus": true, "name": "DELIVERED", "value": "delivered" }, "type": [ "string", "null" ], "enum": [ "confirmed", "in_transit", "out_for_delivery", "delivered", "failure", "undeliverable", "returned_to_sender", "available_for_collection", null ] }, "providerStatus": { "description": "Shipment status from the provider please note some Providers are not 100% reliable and will occasionally deliver shipments without status updates.", "example": { "terminalStatus": true, "name": "DELIVERED", "value": "delivered" }, "type": [ "string", "null" ] }, "rawProviderHistory": { "description": "Raw shipment history from the provider.", "type": [ "array", "null" ], "items": {} } } }, "ShipmentTracking.jsonld": { "type": "object", "required": [ "provider", "createdAt", "updatedAt" ], "properties": { "provider": { "example": "DHL", "type": "string", "enum": [ "DHL", "Swiss Post", "OTHER" ] }, "createdAt": { "description": "Timestamp when the shipment was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp when the shipment was last updated.", "type": "string", "format": "date-time" }, "trackingCode": { "example": "123", "type": [ "string", "null" ] }, "url": { "example": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html?piececode=123", "type": "string", "format": "url" }, "shipmentStatus": { "description": "Normalized shipment status for informational purposes only.", "example": { "terminalStatus": true, "name": "DELIVERED", "value": "delivered" }, "type": [ "string", "null" ], "enum": [ "confirmed", "in_transit", "out_for_delivery", "delivered", "failure", "undeliverable", "returned_to_sender", "available_for_collection", null ] }, "providerStatus": { "description": "Shipment status from the provider please note some Providers are not 100% reliable and will occasionally deliver shipments without status updates.", "example": { "terminalStatus": true, "name": "DELIVERED", "value": "delivered" }, "type": [ "string", "null" ] }, "rawProviderHistory": { "description": "Raw shipment history from the provider.", "type": [ "array", "null" ], "items": {} } } }, "ShipmentTrackingInput": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "provider": { "description": "Shipment provider responsible for the parcel.", "example": "DHL", "type": "string", "enum": [ "DHL", "Swiss Post", "OTHER" ] }, "trackingCode": { "maxLength": 255, "description": "Optional carrier tracking code for the shipment.", "example": "TRACK-123456", "type": [ "string", "null" ] }, "url": { "format": "url", "description": "Optional tracking URL. If omitted, the system generates one for supported providers when a tracking code is provided.", "externalDocs": { "url": "https://schema.org/url" }, "example": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html?piececode=TRACK-123456", "type": "string" }, "shipmentStatus": { "description": "Optional shipment status to expose together with the tracking data.", "example": "in_transit", "type": [ "string", "null" ], "enum": [ "confirmed", "in_transit", "out_for_delivery", "delivered", "failure", "undeliverable", "returned_to_sender", "available_for_collection", null ] } }, "required": [ "provider" ] }, "ShipmentTrackingInput.DiagnosticOrder": { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticTests": { "description": "IRIs of the diagnostic tests that belong to this order.", "example": [ "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "createdAt": { "description": "Timestamp when the order was created.", "type": "string", "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when the outbound shipment was handed over.", "example": "2026-05-04T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "shipmentTracking": { "description": "Tracking details for the outbound shipment, when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "shippingAddress": { "description": "Shipping address stored for the order.", "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } }, "ShipmentTrackingInput.DiagnosticOrder.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticTests": { "description": "IRIs of the diagnostic tests that belong to this order.", "example": [ "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "createdAt": { "description": "Timestamp when the order was created.", "type": "string", "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when the outbound shipment was handed over.", "example": "2026-05-04T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "shipmentTracking": { "description": "Tracking details for the outbound shipment, when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "shippingAddress": { "description": "Shipping address stored for the order.", "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput.jsonld" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).", "example": { "yourReference1": "abc", "yourReference2": 123, "yourFlag1": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } } ] }, "ShipmentTrackingInput.DiagnosticTest": { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } }, "ShipmentTrackingInput.DiagnosticTest.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "diagnosticOrder", "diagnosticProduct", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "diagnosticOrder": { "description": "IRI of the parent diagnostic order.", "example": "/v1/diagnostic_orders/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "diagnosticProduct": { "description": "IRI of the DiagnosticProduct that was ordered for this test.", "example": "/v1/diagnostic_products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "testResults": { "description": "IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.", "example": [ "/v1/test_results/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "patient": { "anyOf": [ { "$ref": "#/components/schemas/Patient.jsonld" }, { "type": "null" } ] }, "specimens": { "type": "array", "items": { "$ref": "#/components/schemas/Specimen.jsonld" } }, "shipmentTracking": { "description": "Tracking details for the patient-to-lab shipment when available.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "activatedAt": { "description": "Timestamp when the patient activated the TestKit.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "labIntakeAt": { "description": "Timestamp when the specimen arrived in the laboratory.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "replacementDiagnosticTest": { "description": "IRI of the diagnostic test that replaced this test, when it was replaced.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "replacesDiagnosticTest": { "description": "IRI of the diagnostic test this test replaces, when applicable.", "example": "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "canceledAt": { "description": "Timestamp when the diagnostic test was canceled.", "example": "2026-05-04T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "completedAt": { "description": "Timestamp when the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "description": "Timestamp when fulfillment of the diagnostic test was completed.", "example": "2026-05-06T07:45:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "description": "Timestamp when the DiagnosticTest was created.", "type": "string", "format": "date-time" } } } ] }, "Specimen": { "type": "object", "required": [ "specimenCode", "createdAt" ], "properties": { "specimenCode": { "description": "Laboratory specimen code or sample identifier.", "example": "ABC-123456", "type": "string" }, "createdAt": { "description": "Timestamp when the specimen record was created.", "type": "string", "format": "date-time" }, "collectionDate": { "description": "Date when the specimen was collected.", "example": "2026-05-04", "type": "string", "format": "date" }, "collectionTime": { "description": "Time of day when the specimen was collected.", "example": "13:50:00", "type": "string", "pattern": "^\\d{2}:\\d{2}:\\d{2}$" }, "menstrualPhaseAtCollection": { "description": "Menstrual phase reported at collection time, when applicable.", "type": [ "string", "null" ], "enum": [ "follikel", "ovulation", "luteal", "menopause", null ] } } }, "Specimen.jsonld": { "type": "object", "required": [ "specimenCode", "createdAt" ], "properties": { "specimenCode": { "description": "Laboratory specimen code or sample identifier.", "example": "ABC-123456", "type": "string" }, "createdAt": { "description": "Timestamp when the specimen record was created.", "type": "string", "format": "date-time" }, "collectionDate": { "description": "Date when the specimen was collected.", "example": "2026-05-04", "type": "string", "format": "date" }, "collectionTime": { "description": "Time of day when the specimen was collected.", "example": "13:50:00", "type": "string", "pattern": "^\\d{2}:\\d{2}:\\d{2}$" }, "menstrualPhaseAtCollection": { "description": "Menstrual phase reported at collection time, when applicable.", "type": [ "string", "null" ], "enum": [ "follikel", "ovulation", "luteal", "menopause", null ] } } }, "TestResult": { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "description": "Timestamp when the test result was created.", "type": "string", "format": "date-time" }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/Observation" } }, "documents": { "description": "Embedded document metadata objects, such as PDF reports. Unlike most relations in this API, documents are included inline for convenience.", "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "labNotes": { "description": "Free-text laboratory notes attached to the test result.", "type": [ "array", "null" ], "items": { "type": "string" } }, "diagnosticTest": { "type": "string" } } }, "TestResult.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "description": "Timestamp when the test result was created.", "type": "string", "format": "date-time" }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/Observation.jsonld" } }, "documents": { "description": "Embedded document metadata objects, such as PDF reports. Unlike most relations in this API, documents are included inline for convenience.", "type": "array", "items": { "$ref": "#/components/schemas/Document.jsonld" } }, "labNotes": { "description": "Free-text laboratory notes attached to the test result.", "type": [ "array", "null" ], "items": { "type": "string" } }, "diagnosticTest": { "type": "string" } } } ] }, "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": "Diagnostic Orders", "description": "Resource 'Diagnostic Orders' operations." }, { "name": "Diagnostic Products", "description": "Resource 'Diagnostic Products' operations." }, { "name": "Diagnostic Tests", "description": "Resource 'Diagnostic Tests' operations." }, { "name": "Documents", "description": "Resource 'Documents' operations." }, { "name": "External Activation", "description": "Resource 'External Activation' operations." }, { "name": "External Fulfillment", "description": "Resource 'External Fulfillment' operations." }, { "name": "GDPR Erasure", "description": "Resource 'GDPR Erasure' operations." }, { "name": "Observations", "description": "Resource 'Observations' operations." }, { "name": "Test Results", "description": "Resource 'Test Results' operations." } ], "webhooks": {} }