{ "openapi": "3.1.0", "info": { "title": "BioParse Clinic Integration API", "description": "Read-only clinic access for server-side integrations. Results contain accepted metadata and final stored observations. Names and catalog metadata may reflect current records; pagination is not an export snapshot.", "version": "1.0.0" }, "servers": [ { "url": "https://api.bioparse.co", "description": "Production clinic data" }, { "url": "https://staging.api.bioparse.co", "description": "Staging clinic data; not a synthetic sandbox" } ], "paths": { "/v1/clinic": { "get": { "tags": [ "Clinic" ], "summary": "Retrieve your clinic", "operationId": "publicClinicRead", "responses": { "200": { "description": "Current clinic", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicClinic" } } } }, "400": { "description": "Unknown query parameter", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidInput" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer credential challenge" }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidKey" } } } }, "403": { "description": "Missing clinic:read scope", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInsufficientScope" } } } }, "404": { "description": "Resource absent", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicResourceNotFound" } } } }, "408": { "description": "Request body receipt timed out", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBodyTimeout" } } } }, "413": { "description": "Request body exceeds the size limit", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTooLarge" } } } }, "429": { "description": "Request allowance exhausted", "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Seconds until the exhausted request allowance resets." }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRateLimited" } } } }, "503": { "description": "Temporarily unavailable", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PublicUnavailable" }, { "$ref": "#/components/schemas/RequestUnavailable" } ] } } } } }, "security": [ { "clinicApiKey": [] } ] } }, "/v1/patients": { "get": { "tags": [ "Patients" ], "summary": "List clinic patients", "operationId": "publicPatientsList", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 100, "minimum": 1 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Patients in UUID ascending order", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPage_PublicPatient" } } } }, "400": { "description": "Invalid or unknown query parameter", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidInput" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer credential challenge" }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidKey" } } } }, "403": { "description": "Missing patients:read scope", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInsufficientScope" } } } }, "408": { "description": "Request body receipt timed out", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBodyTimeout" } } } }, "413": { "description": "Request body exceeds the size limit", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTooLarge" } } } }, "429": { "description": "Request allowance exhausted", "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Seconds until the exhausted request allowance resets." }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRateLimited" } } } }, "503": { "description": "Temporarily unavailable", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PublicUnavailable" }, { "$ref": "#/components/schemas/RequestUnavailable" } ] } } } } }, "security": [ { "clinicApiKey": [] } ] } }, "/v1/patients/{id}": { "get": { "tags": [ "Patients" ], "summary": "Retrieve a patient", "operationId": "publicPatientsRead", "parameters": [ { "name": "id", "in": "path", "description": "Patient UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Clinic patient", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPatient" } } } }, "400": { "description": "Invalid identifier", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidInput" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer credential challenge" }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidKey" } } } }, "403": { "description": "Missing patients:read scope", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInsufficientScope" } } } }, "404": { "description": "Resource absent", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicResourceNotFound" } } } }, "408": { "description": "Request body receipt timed out", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBodyTimeout" } } } }, "413": { "description": "Request body exceeds the size limit", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTooLarge" } } } }, "429": { "description": "Request allowance exhausted", "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Seconds until the exhausted request allowance resets." }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRateLimited" } } } }, "503": { "description": "Temporarily unavailable", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PublicUnavailable" }, { "$ref": "#/components/schemas/RequestUnavailable" } ] } } } } }, "security": [ { "clinicApiKey": [] } ] } }, "/v1/results": { "get": { "tags": [ "Results" ], "summary": "List approved results", "operationId": "publicResultsList", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 100, "minimum": 1 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "patientId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Accepted results in UUID ascending order", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPage_PublicResult" } } } }, "400": { "description": "Invalid or unknown query parameter", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidInput" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer credential challenge" }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidKey" } } } }, "403": { "description": "Missing results:read scope", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInsufficientScope" } } } }, "404": { "description": "Patient filter absent from clinic", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicResourceNotFound" } } } }, "408": { "description": "Request body receipt timed out", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBodyTimeout" } } } }, "413": { "description": "Request body exceeds the size limit", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTooLarge" } } } }, "429": { "description": "Request allowance exhausted", "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Seconds until the exhausted request allowance resets." }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRateLimited" } } } }, "503": { "description": "Temporarily unavailable", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PublicUnavailable" }, { "$ref": "#/components/schemas/RequestUnavailable" } ] } } } } }, "security": [ { "clinicApiKey": [] } ] } }, "/v1/results/{id}": { "get": { "tags": [ "Results" ], "summary": "Retrieve an approved result", "operationId": "publicResultsRead", "parameters": [ { "name": "id", "in": "path", "description": "Accepted result UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Accepted result metadata", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicResult" } } } }, "400": { "description": "Invalid identifier", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidInput" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer credential challenge" }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidKey" } } } }, "403": { "description": "Missing results:read scope", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInsufficientScope" } } } }, "404": { "description": "Accepted resource absent", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicResourceNotFound" } } } }, "408": { "description": "Request body receipt timed out", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBodyTimeout" } } } }, "413": { "description": "Request body exceeds the size limit", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTooLarge" } } } }, "429": { "description": "Request allowance exhausted", "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Seconds until the exhausted request allowance resets." }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRateLimited" } } } }, "503": { "description": "Temporarily unavailable", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PublicUnavailable" }, { "$ref": "#/components/schemas/RequestUnavailable" } ] } } } } }, "security": [ { "clinicApiKey": [] } ] } }, "/v1/results/{id}/observations": { "get": { "tags": [ "Results" ], "summary": "List final result observations", "operationId": "publicResultObservationsList", "parameters": [ { "name": "id", "in": "path", "description": "Accepted result UUID", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 100, "minimum": 1 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Final stored observations in final-row UUID ascending order", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPage_PublicObservation" } } } }, "400": { "description": "Invalid query or identifier", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidInput" } } } }, "401": { "description": "Invalid, expired or revoked key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer credential challenge" }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvalidKey" } } } }, "403": { "description": "Missing results:read scope", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInsufficientScope" } } } }, "404": { "description": "Accepted parent result absent", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicResourceNotFound" } } } }, "408": { "description": "Request body receipt timed out", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBodyTimeout" } } } }, "413": { "description": "Request body exceeds the size limit", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTooLarge" } } } }, "429": { "description": "Request allowance exhausted", "headers": { "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Seconds until the exhausted request allowance resets." }, "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRateLimited" } } } }, "503": { "description": "Temporarily unavailable", "headers": { "x-request-id": { "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "description": "Server-generated request correlation identifier. Incoming identifiers are never reused." } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PublicUnavailable" }, { "$ref": "#/components/schemas/RequestUnavailable" } ] } } } } }, "security": [ { "clinicApiKey": [] } ] } } }, "components": { "schemas": { "BiomarkerBodyRegion": { "type": "string", "enum": [ "BRAIN", "NECK_FACE", "CHEST", "ABDOMEN", "PELVIS", "BONES_SPINE", "LIMBS", "SOFT_TISSUES_MUSCLE", "BREAST", "OTHER" ] }, "BiomarkerLaterality": { "type": "string", "enum": [ "LEFT", "RIGHT", "BILATERAL", "MIDLINE" ] }, "BiomarkerOrgan": { "type": "string", "enum": [ "BRAIN", "CEREBELLUM", "BRAINSTEM", "PITUITARY", "EYE", "EAR", "SINUS", "THYROID", "PARATHYROID", "SALIVARY_GLAND", "PHARYNX", "LARYNX", "ORAL_CAVITY", "LYMPH_NODE", "LUNG", "HEART", "MEDIASTINUM", "PLEURA", "ESOPHAGUS", "THYMUS", "CHEST_WALL", "LIVER", "GALLBLADDER", "BILE_DUCTS", "PANCREAS", "SPLEEN", "KIDNEY", "ADRENAL_GLAND", "STOMACH", "SMALL_BOWEL", "COLON", "AORTA", "IVC", "ABDOMINAL_WALL", "BLADDER", "PROSTATE", "UTERUS", "OVARY", "CERVIX", "VAGINA", "RECTUM", "TESTIS", "BONE", "SPINE", "VERTEBRA", "INTERVERTEBRAL_DISC", "SPINAL_CORD", "SACROILIAC_JOINT", "JOINT", "SHOULDER", "ARM", "ELBOW", "WRIST", "HAND", "HIP", "LEG", "KNEE", "ANKLE", "FOOT", "MUSCLE", "TENDON", "LIGAMENT", "FASCIA", "SKIN", "SUBCUTANEOUS_TISSUE", "NERVE", "VESSEL", "BREAST", "AXILLA", "OTHER" ] }, "BiomarkerType": { "type": "string", "enum": [ "METRIC", "FINDING", "REGION_ASSESSMENT" ] }, "ClinicalRangeStatus": { "type": "string", "enum": [ "NORMAL", "BORDERLINE", "HIGH", "LOW" ] }, "Dimension": { "type": "object", "required": [ "label", "unit", "value" ], "properties": { "label": { "type": [ "string", "null" ] }, "unit": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "additionalProperties": false }, "PublicAnatomy": { "type": "object", "required": [ "bodyRegion", "laterality", "anatomicalSite", "organ" ], "properties": { "anatomicalSite": { "type": [ "string", "null" ] }, "bodyRegion": { "oneOf": [ { "$ref": "#/components/schemas/BiomarkerBodyRegion" }, { "type": "null" } ] }, "laterality": { "oneOf": [ { "$ref": "#/components/schemas/BiomarkerLaterality" }, { "type": "null" } ] }, "organ": { "oneOf": [ { "$ref": "#/components/schemas/BiomarkerOrgan" }, { "type": "null" } ] } }, "additionalProperties": false }, "PublicClinic": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false }, "PublicInsufficientScope": { "oneOf": [ { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "public_api.insufficient_scope" ] } }, "additionalProperties": false } ] }, "PublicInvalidInput": { "oneOf": [ { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "public_api.invalid_input" ] } }, "additionalProperties": false } ] }, "PublicInvalidKey": { "oneOf": [ { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "public_api.invalid_key" ] } }, "additionalProperties": false } ] }, "PublicObservation": { "type": "object", "required": [ "id", "clinicBiomarkerId", "name", "type", "value", "unit", "referenceRange", "rangeStatus", "anatomy", "dimensions", "scores" ], "properties": { "anatomy": { "$ref": "#/components/schemas/PublicAnatomy" }, "clinicBiomarkerId": { "type": "string", "format": "uuid" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/Dimension" } }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "rangeStatus": { "oneOf": [ { "$ref": "#/components/schemas/ClinicalRangeStatus" }, { "type": "null" } ] }, "referenceRange": { "type": [ "string", "null" ] }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/Score" } }, "type": { "$ref": "#/components/schemas/BiomarkerType" }, "unit": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "PublicPage_PublicObservation": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "clinicBiomarkerId", "name", "type", "value", "unit", "referenceRange", "rangeStatus", "anatomy", "dimensions", "scores" ], "properties": { "anatomy": { "$ref": "#/components/schemas/PublicAnatomy" }, "clinicBiomarkerId": { "type": "string", "format": "uuid" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/Dimension" } }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "rangeStatus": { "oneOf": [ { "$ref": "#/components/schemas/ClinicalRangeStatus" }, { "type": "null" } ] }, "referenceRange": { "type": [ "string", "null" ] }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/Score" } }, "type": { "$ref": "#/components/schemas/BiomarkerType" }, "unit": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "nextCursor": { "type": [ "string", "null" ], "format": "uuid" } }, "additionalProperties": false }, "PublicPage_PublicPatient": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "birthdate", "sex" ], "properties": { "birthdate": { "type": "string", "format": "date" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "sex": { "$ref": "#/components/schemas/Sex" } }, "additionalProperties": false } }, "nextCursor": { "type": [ "string", "null" ], "format": "uuid" } }, "additionalProperties": false }, "PublicPage_PublicResult": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "appointmentId", "patientId", "appointmentDate", "title", "approvedAt", "createdAt", "updatedAt" ], "properties": { "appointmentDate": { "type": "string", "format": "date-time" }, "appointmentId": { "type": "string", "format": "uuid" }, "approvedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "patientId": { "type": "string", "format": "uuid" }, "title": { "type": [ "string", "null" ] }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "nextCursor": { "type": [ "string", "null" ], "format": "uuid" } }, "additionalProperties": false }, "PublicPatient": { "type": "object", "required": [ "id", "name", "birthdate", "sex" ], "properties": { "birthdate": { "type": "string", "format": "date" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "sex": { "$ref": "#/components/schemas/Sex" } }, "additionalProperties": false }, "PublicResourceNotFound": { "oneOf": [ { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "public_api.not_found" ] } }, "additionalProperties": false } ] }, "PublicResult": { "type": "object", "required": [ "id", "appointmentId", "patientId", "appointmentDate", "title", "approvedAt", "createdAt", "updatedAt" ], "properties": { "appointmentDate": { "type": "string", "format": "date-time" }, "appointmentId": { "type": "string", "format": "uuid" }, "approvedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "patientId": { "type": "string", "format": "uuid" }, "title": { "type": [ "string", "null" ] }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PublicUnavailable": { "oneOf": [ { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "public_api.unavailable" ] } }, "additionalProperties": false } ] }, "RequestBodyTimeout": { "type": "object", "required": [ "code" ], "properties": { "code": { "$ref": "#/components/schemas/RequestBodyTimeoutCode" } }, "additionalProperties": false }, "RequestBodyTimeoutCode": { "type": "string", "enum": [ "request.body_timeout" ] }, "RequestRateLimitCode": { "type": "string", "enum": [ "request.rate_limited" ] }, "RequestRateLimited": { "type": "object", "required": [ "code", "retryAfterSeconds" ], "properties": { "code": { "$ref": "#/components/schemas/RequestRateLimitCode" }, "retryAfterSeconds": { "type": "integer", "format": "int32", "minimum": 1 } }, "additionalProperties": false }, "RequestTooLarge": { "type": "object", "required": [ "code" ], "properties": { "code": { "$ref": "#/components/schemas/RequestTooLargeCode" } }, "additionalProperties": false }, "RequestTooLargeCode": { "type": "string", "enum": [ "request.body_too_large" ] }, "RequestUnavailable": { "type": "object", "required": [ "code" ], "properties": { "code": { "$ref": "#/components/schemas/RequestUnavailableCode" } }, "additionalProperties": false }, "RequestUnavailableCode": { "type": "string", "enum": [ "request.unavailable" ] }, "Score": { "type": "object", "required": [ "system", "value" ], "properties": { "system": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "Sex": { "type": "string", "enum": [ "FEMALE", "MALE" ] } }, "securitySchemes": { "clinicApiKey": { "type": "http", "scheme": "bearer" } } } }