{ "openapi": "3.2.0", "info": { "title": "Probatix Specimen Collection Kit API v1", "description": "## About This API\n\nThe Specimen Collection Kit API (`SCK API`) is used for fulfillment-only kit ordering.\n\nUse this API when Probatix is responsible for shipping specimen collection kits,\nbut does not handle the diagnostic workflow itself.\n\nIn practice, this API focuses on:\n\n- browsing orderable specimen collection kit products\n- browsing available specimen collection kits\n- creating kit orders\n- checking shipment-related order details\n\nIn this API, `products` represent orderable catalog items, while `kits` represent specimen collection kit entities\nthat may need to be tracked separately for operational or billing purposes.\n\nIt intentionally does not model diagnostic data such as observations, test results,\nor broader patient details beyond shipment contact information.\n## 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": { "/sck/v1/orders": { "get": { "operationId": "api_sckv1orders_get_collection", "tags": [ "SCK Orders" ], "responses": { "200": { "description": "SpecimenCollectionKitOrder collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpecimenCollectionKitOrder" } } }, "application/ld+json": { "schema": { "type": "object", "description": "SpecimenCollectionKitOrder.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/SpecimenCollectionKitOrder.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 SpecimenCollectionKitOrder resources.", "description": "Retrieves the collection of SpecimenCollectionKitOrder 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": "json_exact", "in": "query", "description": "Exact match on one or more JSON values addressed by dotted JSON paths such as `metadata.id`.", "required": false, "deprecated": false, "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "style": "deepObject", "explode": true, "example": { "metadata.id": [ "externalId", "anotherId" ] } }, { "name": "json_exists", "in": "query", "description": "Checks whether a dotted JSON path exists and resolves to a non-null value.", "required": false, "deprecated": false, "schema": { "type": "object", "additionalProperties": { "type": "boolean" } }, "style": "deepObject", "explode": true, "example": { "metadata.id": true } }, { "name": "json_search", "in": "query", "description": "Case-insensitive partial match on one or more JSON values addressed by dotted JSON paths such as `metadata.id`.", "required": false, "deprecated": false, "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "style": "deepObject", "explode": true, "example": { "metadata.id": [ "externalId", "anotherId" ] } }, { "name": "kit[]", "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": "order[]", "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": "product[]", "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": "SpecimenCollectionKitOrder sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[createdAt][]", "in": "query", "description": "SpecimenCollectionKitOrder 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": "SpecimenCollectionKitOrder sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "SpecimenCollectionKitOrder 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_SCK_v1" ] }, "post": { "operationId": "api_sckv1orders_post", "tags": [ "SCK Orders" ], "responses": { "201": { "description": "SpecimenCollectionKitOrderInput resource created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrderInput.SpecimenCollectionKitOrder" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrderInput.SpecimenCollectionKitOrder.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 SpecimenCollectionKitOrderInput resource.", "description": "Create an SCK order. `productIds` accepts a UUID, canonical ID, or `/sck/v1/products/{id}` IRI for each product. Canonical IDs are recommended because product UUIDs are not guaranteed to match between demo and production environments.", "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 SpecimenCollectionKitOrderInput resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrderInput" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrderInput" } } }, "required": true }, "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_SCK_v1" ] } }, "/sck/v1/orders/{id}": { "get": { "operationId": "api_sckv1orders_id_get", "tags": [ "SCK Orders" ], "responses": { "200": { "description": "SpecimenCollectionKitOrder resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrder" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitOrder.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 SpecimenCollectionKitOrder resource.", "description": "Retrieves a SpecimenCollectionKitOrder 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": "SpecimenCollectionKitOrder identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_SCK_v1" ] } }, "/v1/sck/orders/{id}/cancel": { "post": { "operationId": "api_v1sckorders_idcancel_post", "tags": [ "SCK Orders" ], "responses": { "200": { "description": "SckOrderCancel 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 an SCK order", "description": "Cancels an SCK order if fulfillment actions have not started.", "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": "SckOrderCancel identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_SCK_v1" ] } }, "/sck/v1/products": { "get": { "operationId": "api_sckv1products_get_collection", "tags": [ "SCK Products" ], "responses": { "200": { "description": "SpecimenCollectionKitProduct collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpecimenCollectionKitProduct" } } }, "application/ld+json": { "schema": { "type": "object", "description": "SpecimenCollectionKitProduct.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/SpecimenCollectionKitProduct.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 SpecimenCollectionKitProduct resources.", "description": "Retrieves the collection of SpecimenCollectionKitProduct 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": "product[]", "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[canonicalId]", "in": "query", "description": "SpecimenCollectionKitProduct sort[canonicalId]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[canonicalId][]", "in": "query", "description": "SpecimenCollectionKitProduct sort[canonicalId]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "sort[createdAt]", "in": "query", "description": "SpecimenCollectionKitProduct sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[createdAt][]", "in": "query", "description": "SpecimenCollectionKitProduct 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": "SpecimenCollectionKitProduct sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "SpecimenCollectionKitProduct 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_SCK_v1" ] } }, "/sck/v1/products/{id}": { "get": { "operationId": "api_sckv1products_id_get", "tags": [ "SCK Products" ], "responses": { "200": { "description": "SpecimenCollectionKitProduct resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitProduct" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKitProduct.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 SpecimenCollectionKitProduct resource.", "description": "Retrieves a SpecimenCollectionKitProduct 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": "SpecimenCollectionKitProduct identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_SCK_v1" ] } }, "/sck/v1/kits": { "get": { "operationId": "api_sckv1kits_get_collection", "tags": [ "Specimen Collection Kits" ], "responses": { "200": { "description": "SpecimenCollectionKit collection", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpecimenCollectionKit" } } }, "application/ld+json": { "schema": { "type": "object", "description": "SpecimenCollectionKit.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/SpecimenCollectionKit.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 SpecimenCollectionKit resources.", "description": "Retrieves the collection of SpecimenCollectionKit 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": "fulfilledAt[gt]", "in": "query", "description": "Return resources with `fulfilledAt` greater than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "fulfilledAt[gte]", "in": "query", "description": "Return resources with `fulfilledAt` greater than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "fulfilledAt[lt]", "in": "query", "description": "Return resources with `fulfilledAt` less than the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "fulfilledAt[lte]", "in": "query", "description": "Return resources with `fulfilledAt` less than or equal to the given timestamp.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "kit[]", "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": "order[]", "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": "product[]", "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": "SpecimenCollectionKit sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[createdAt][]", "in": "query", "description": "SpecimenCollectionKit sort[createdAt]", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] } }, "style": "deepObject", "explode": true }, { "name": "sort[fulfilledAt]", "in": "query", "description": "SpecimenCollectionKit sort[fulfilledAt]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[fulfilledAt][]", "in": "query", "description": "SpecimenCollectionKit sort[fulfilledAt]", "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": "SpecimenCollectionKit sort[id]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sort[id][]", "in": "query", "description": "SpecimenCollectionKit 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_SCK_v1" ] } }, "/sck/v1/kits/{id}": { "get": { "operationId": "api_sckv1kits_id_get", "tags": [ "Specimen Collection Kits" ], "responses": { "200": { "description": "SpecimenCollectionKit resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKit" } }, "application/ld+json": { "schema": { "$ref": "#/components/schemas/SpecimenCollectionKit.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 SpecimenCollectionKit resource.", "description": "Retrieves a SpecimenCollectionKit 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": "SpecimenCollectionKit identifier", "required": true, "deprecated": false, "schema": { "type": "string", "format": "uuid" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_SCK_v1" ] } }, "/v1/sck/kits/{id}/replace": { "post": { "operationId": "api_v1sckkits_idreplace_post", "tags": [ "Specimen Collection Kits" ], "responses": { "200": { "description": "SckKitReplace 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 fulfilled SCK kit", "description": "Creates a replacement SCK order for a fulfilled kit.", "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": "SckKitReplace identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "apiKey": [] } ], "x-apiplatform-tag": [ "Probatix_SCK_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" }, "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" ] } } }, "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" ] }, "ShipmentContact": { "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" }, "phone": { "example": "030 12345678", "type": [ "string", "null" ] } } }, "ShipmentContact.jsonld": { "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" }, "phone": { "example": "030 12345678", "type": [ "string", "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": {} } } }, "SpecimenCollectionKit": { "type": "object", "required": [ "id", "product", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "product": { "description": "IRI of the specimen collection kit product this kit belongs to.", "example": "/sck/v1/products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "fulfillmentData": { "description": "Optional fulfillment-specific data. Values must be JSON primitive values.", "example": { "barcode": "PX-123456789", "kitId": "KIT-2026-000123", "verified": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "udi": { "description": "Parsed unique device identifier details when a UDI is linked to this kit.", "anyOf": [ { "$ref": "#/components/schemas/UniqueDeviceIdentifierDetail" }, { "type": "null" } ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": "string", "format": "date-time" }, "fulfilledAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "replacesKit": { "description": "IRI of the SCK kit this kit replaces.", "type": [ "string", "null" ] }, "replacementKit": { "description": "IRI of the SCK kit that replaced this kit.", "type": [ "string", "null" ] } } }, "SpecimenCollectionKit.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "product", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "product": { "description": "IRI of the specimen collection kit product this kit belongs to.", "example": "/sck/v1/products/00112233-4455-6677-8899-aabbccddeeff", "type": "string", "format": "iri-reference" }, "fulfillmentData": { "description": "Optional fulfillment-specific data. Values must be JSON primitive values.", "example": { "barcode": "PX-123456789", "kitId": "KIT-2026-000123", "verified": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "udi": { "description": "Parsed unique device identifier details when a UDI is linked to this kit.", "anyOf": [ { "$ref": "#/components/schemas/UniqueDeviceIdentifierDetail.jsonld" }, { "type": "null" } ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": "string", "format": "date-time" }, "fulfilledAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "replacesKit": { "description": "IRI of the SCK kit this kit replaces.", "type": [ "string", "null" ] }, "replacementKit": { "description": "IRI of the SCK kit that replaced this kit.", "type": [ "string", "null" ] } } } ] }, "SpecimenCollectionKitOrder": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kits": { "description": "IRIs of the specimen collection kits that belong to this order.", "example": [ "/sck/v1/kits/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "contact": { "$ref": "#/components/schemas/ShipmentContact" }, "shippingAddress": { "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Values must be JSON primitive values.", "example": { "yourReference1": "abc", "yourReference2": 123, "priority": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "status": { "description": "Current SCK order status.", "example": "new", "type": "string", "enum": [ "new", "fulfilled", "canceled" ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "example": "2026-06-30T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] } } }, "SpecimenCollectionKitOrder.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kits": { "description": "IRIs of the specimen collection kits that belong to this order.", "example": [ "/sck/v1/kits/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "contact": { "$ref": "#/components/schemas/ShipmentContact.jsonld" }, "shippingAddress": { "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput.jsonld" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Values must be JSON primitive values.", "example": { "yourReference1": "abc", "yourReference2": 123, "priority": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "status": { "description": "Current SCK order status.", "example": "new", "type": "string", "enum": [ "new", "fulfilled", "canceled" ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "example": "2026-06-30T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] } } } ] }, "SpecimenCollectionKitOrderInput": { "type": "object", "required": [ "productIds", "contact", "shippingAddress" ], "properties": { "productIds": { "minItems": 1, "description": "Identifiers of the specimen collection kit products to order. Each entry may be a UUID, an SCK product IRI, or a canonical ID. Provide at least one product ID.", "example": [ "/sck/v1/products/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string" } }, "contact": { "$ref": "#/components/schemas/ShipmentContact" }, "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, "priority": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } } } }, "SpecimenCollectionKitOrderInput.SpecimenCollectionKitOrder": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kits": { "description": "IRIs of the specimen collection kits that belong to this order.", "example": [ "/sck/v1/kits/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "contact": { "$ref": "#/components/schemas/ShipmentContact" }, "shippingAddress": { "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Values must be JSON primitive values.", "example": { "yourReference1": "abc", "yourReference2": 123, "priority": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "status": { "description": "Current SCK order status.", "example": "new", "type": "string", "enum": [ "new", "fulfilled", "canceled" ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "example": "2026-06-30T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking" }, { "type": "null" } ] } } }, "SpecimenCollectionKitOrderInput.SpecimenCollectionKitOrder.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kits": { "description": "IRIs of the specimen collection kits that belong to this order.", "example": [ "/sck/v1/kits/00112233-4455-6677-8899-aabbccddeeff" ], "type": "array", "items": { "type": "string", "format": "iri-reference" } }, "contact": { "$ref": "#/components/schemas/ShipmentContact.jsonld" }, "shippingAddress": { "anyOf": [ { "$ref": "#/components/schemas/FullAddressInput.jsonld" }, { "type": "null" } ] }, "metadata": { "description": "Optional partner-defined metadata. Values must be JSON primitive values.", "example": { "yourReference1": "abc", "yourReference2": 123, "priority": true }, "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ] } }, "status": { "description": "Current SCK order status.", "example": "new", "type": "string", "enum": [ "new", "fulfilled", "canceled" ] }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "fulfilledAt": { "example": "2026-06-30T09:15:00+00:00", "type": [ "string", "null" ], "format": "date-time" }, "outboundShipment": { "description": "Outbound shipment for this kit when its fulfillment bundle has been shipped.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] }, "returnShipment": { "description": "Return shipment for this kit when its fulfillment bundle has one.", "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.jsonld" }, { "type": "null" } ] } } } ] }, "SpecimenCollectionKitProduct": { "type": "object", "required": [ "id", "canonicalId", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "canonicalId": { "example": "sck_standard_home_collection", "type": "string" }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": "string", "format": "date-time" } } }, "SpecimenCollectionKitProduct.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "required": [ "id", "canonicalId", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "canonicalId": { "example": "sck_standard_home_collection", "type": "string" }, "createdAt": { "example": "2026-06-29T10:30:00+00:00", "type": "string", "format": "date-time" } } } ] }, "UniqueDeviceIdentifierDetail": { "type": "object", "required": [ "normalizedText", "deviceIdentifier" ], "properties": { "normalizedText": { "example": "(01)05056751601985(10)PCCN000844(17)270831(240)KT90011", "type": "string" }, "deviceIdentifier": { "example": "05056751601985", "type": "string" }, "lotNumber": { "example": "PCCN000844", "type": [ "string", "null" ] }, "serialNumber": { "type": [ "string", "null" ] }, "additionalProductIdentifier": { "example": "KT90011", "type": [ "string", "null" ] }, "expirationDate": { "example": "2027-08-31", "type": [ "string", "null" ], "format": "date-time" }, "manufactureDate": { "example": "2026-06-15", "type": [ "string", "null" ], "format": "date-time" } } }, "UniqueDeviceIdentifierDetail.jsonld": { "type": "object", "required": [ "normalizedText", "deviceIdentifier" ], "properties": { "normalizedText": { "example": "(01)05056751601985(10)PCCN000844(17)270831(240)KT90011", "type": "string" }, "deviceIdentifier": { "example": "05056751601985", "type": "string" }, "lotNumber": { "example": "PCCN000844", "type": [ "string", "null" ] }, "serialNumber": { "type": [ "string", "null" ] }, "additionalProductIdentifier": { "example": "KT90011", "type": [ "string", "null" ] }, "expirationDate": { "example": "2027-08-31", "type": [ "string", "null" ], "format": "date-time" }, "manufactureDate": { "example": "2026-06-15", "type": [ "string", "null" ], "format": "date-time" } } }, "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": "Specimen Collection Kits", "description": "Resource 'Specimen Collection Kits' operations." }, { "name": "SCK Orders", "description": "Resource 'SCK Orders' operations." }, { "name": "SCK Products", "description": "Resource 'SCK Products' operations." } ], "webhooks": {} }