{ "openapi": "3.0.0", "paths": { "/auth/token/exchange": { "post": { "description": "\n

Exchange a long-lived API key for a short-lived JWT access token (15 minutes).

\n

This provides enhanced security by minimizing API key exposure.

\n\n

Permissions and Scope:

\n\n\n

Rate Limits:

\n\n\n

Security Features:

\n\n\n

Usage Pattern:

\n
    \n
  1. Exchange API key for access token at secure endpoint
    2. \n
  2. Use access token for API calls (never use API key directly)
    3. \n
  3. Re-exchange when token expires (every 15 minutes)
    4. \n
\n\n

This follows OAuth 2.0 Token Exchange (RFC 8693) patterns.

\n", "operationId": "exchangeToken", "parameters": [ { "name": "User-Agent", "in": "header", "description": "Client identification for security monitoring", "required": false, "schema": { "type": "string" } }, { "name": "X-Forwarded-For", "in": "header", "description": "Client IP address for rate limiting and monitoring", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "Token exchange request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenExchangeRequestDto" } } } }, "responses": { "200": { "description": "Token exchange successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenExchangeResponseDto" } } } }, "400": { "description": "Invalid request (bad API key, invalid scope, etc.)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenExchangeErrorDto" } } } }, "403": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorDto" } } } }, "429": { "description": "Too many requests - API key temporarily suspended", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorDto" } } } } }, "summary": "Exchange API key for short-lived access token", "tags": [ "token-exchange" ] } }, "/health": { "get": { "description": "\n

Health check endpoint that returns the application status, uptime, and version information.

\n

This endpoint is used by load balancers and monitoring systems.

\n

Note: This endpoint does not require authentication.

\n", "operationId": "getHealth", "parameters": [], "responses": { "200": { "description": "Application is healthy", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "error" ], "example": "ok" }, "timestamp": { "type": "string", "format": "date-time", "example": "2024-09-10T10:30:00.000Z" }, "uptime": { "type": "number", "example": 3600000, "description": "Application uptime in milliseconds" }, "version": { "type": "string", "example": "1.0.0", "description": "Application version from package.json" }, "databaseSource": { "type": "string", "enum": [ "mongo" ], "example": "mongo", "description": "Active database source implementation" } } } } } } }, "summary": "Health check", "tags": [ "health" ] } }, "/openapi/health": { "get": { "operationId": "getHealthLegacy", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "health" ] } }, "/api/residents": { "get": { "description": "\n

Retrieves residents with personal details, medical history, room location, and care preferences.

\n

Filters:

\n\n", "operationId": "getResidents", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "resident-456-def", "type": "string" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on", "schema": { "example": "created_on", "type": "string", "enum": [ "created_on", "date_of_birth", "admission_date", "status_changed_on", "ingested_on" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResidentResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] }, { "bearer": [] } ], "summary": "Get residents", "tags": [ "Modules / Residents" ] }, "post": { "operationId": "createResident", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResidentDto" } } } }, "responses": { "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "409": { "description": "Resident with this externalSource already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Create resident", "tags": [ "Modules / Residents" ] } }, "/api/residents/{id}": { "get": { "description": "\n

Retrieves complete resident information including medical history, allergies, GP details, care preferences, and room location.

\n", "operationId": "getResidentById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the resident", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved resident", "content": { "application/json": { "schema": { "example": { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson" }, "email": "margaret.thompson@example.com", "gender": "female", "dateOfBirth": "1945-06-15T00:00:00.000Z", "createdOn": "2026-01-15T09:30:00.000Z", "admissionDate": "2026-01-10T00:00:00.000Z", "preferredName": "Maggie", "status": "active", "statusChangedOn": "2026-01-20T10:00:00.000Z", "isInactive": false, "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "location": { "roomName": "Room 12", "unit": "Oak Wing", "floor": "1" }, "nhsNumber": "999 000 0001", "bloodType": "O+", "allergies": "Penicillin", "hasAllergies": true, "noKnownAllergies": false, "residentAllergies": [ "Penicillin", "Latex" ], "medicalHistory": "Hypertension, Type 2 diabetes", "height": "165cm", "gpCode": "G1234567", "gpName": "Dr. Sarah Williams", "gpEmail": "sarah.williams@nhs.example.com", "gpTelephone": "+44 1632 960123", "gpAddress": { "street1": "1 Example Lane", "suburb": "Exampletown", "postcode": "EX1 1CD", "country": "United Kingdom" }, "gpSurgeryName": "Example Medical Practice", "phones": [ { "number": "+44 7700 900123", "type": "mobile" } ], "addresses": [ { "street1": "45 Example Avenue", "suburb": "Exampletown", "postcode": "EX1 1EF", "country": "United Kingdom", "isCurrent": true, "isPrevious": false } ], "importantContacts": [ { "name": { "first": "Robert", "last": "Thompson" }, "relationship": "Son", "nextOfKin": true, "lpa": true, "phone": "+44 7700 900456", "email": "robert.thompson@example.com", "addresses": [ { "street1": "1 Example Street", "suburb": "Leeds", "postcode": "EX1 1EX", "country": "United Kingdom" } ] } ], "preferredContactMethod": "noPreference", "religion": "Christian", "ethnicity": "White British", "nationality": "British", "nationalities": [ "British" ], "languagesSpoken": [ "English" ], "maritalStatus": "widowed", "birthplace": "York", "sexualPreference": "heterosexual", "carePackage": { "fundingSource": "localAuthority", "fundingSourceNotes": "Funded by York City Council", "fundingSourceOther": "" }, "fundingSource": "localAuthority", "fundingSourceNotes": "Funded by York City Council", "fundingSourceOther": "", "keyworkers": [ "68406c31e55ca6b6d2262f56" ], "carerPreferences": { "gender": "female", "language": "English" }, "preferredDrink": "Tea with milk", "preferredAdminRoute": "oral", "dols": { "status": "authorised", "startDate": "2026-02-01T00:00:00.000Z", "endDate": "2026-08-01T00:00:00.000Z", "reviewDate": "2026-05-01T00:00:00.000Z", "applicationDate": "2026-01-15T00:00:00.000Z" }, "dolsStartDate": "2026-02-01T00:00:00.000Z", "dolsEndDate": "2026-08-01T00:00:00.000Z", "dolsReviewDate": "2026-05-01T00:00:00.000Z", "dolsApplicationDate": "2026-01-15T00:00:00.000Z", "dnacpr": { "hasDnacpr": true, "details": "DNACPR in place, reviewed by GP", "reviewDate": "2026-06-01T00:00:00.000Z", "formPhysicalLocation": "Front of care file" }, "dnacprDetails": "DNACPR in place, reviewed by GP", "dnacprReviewDate": "2026-06-01T00:00:00.000Z", "dnacprFormPhysicalLocation": "Front of care file", "recentMustScore": "1", "recentWaterlowScore": "12", "recentDrinkConsumption": "1500ml", "hasChokingRisk": false, "prnMedsNote": "Paracetamol PRN for pain", "nationalInsurance": "QQ123456C", "summary": "Margaret is a friendly resident who enjoys gardening and reading.", "otherIdentifiers": [ { "type": "localAuthorityRef", "value": "LA-2026-0042" } ], "ageYears": 80 } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Resident not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Resident with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid resident ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] }, { "bearer": [] } ], "summary": "Get resident by ID", "tags": [ "Modules / Residents" ] }, "put": { "operationId": "updateResident", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the resident", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResidentDto" } } } }, "responses": { "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Resident not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Resident with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid resident ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "409": { "description": "Resident with this externalSource already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Update resident", "tags": [ "Modules / Residents" ] } }, "/api/users": { "get": { "description": "\n

Retrieves users with their roles, permissions, and homeIds. Password fields are excluded for security.

\n

Filters:

\n\n", "operationId": "getUsers", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on", "schema": { "default": "created_on", "example": "created_on", "type": "string", "enum": [ "created_on", "start_date", "end_date", "last_seen_on", "first_login_on", "ingested_on" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] }, { "bearer": [] } ], "summary": "Get users", "tags": [ "Modules / Users" ] }, "post": { "operationId": "createUser", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserDto" } } } }, "responses": { "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "409": { "description": "User with this email or externalSource already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Create user", "tags": [ "Modules / Users" ] } }, "/api/users/{id}": { "get": { "description": "\n

Retrieves a complete user profile including roles, permissions, homeIds, and employment details. Password fields are excluded for security.

\n", "operationId": "getUserById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the user", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved user", "content": { "application/json": { "schema": { "example": { "id": "68406c31e55ca6b6d2262f56", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" }, "email": "jane.smith@example.co.uk", "role": "carehome-admin", "cernerRole": "standard", "active": true, "deleted": false, "dateOfBirth": "1985-03-22T00:00:00.000Z", "startDate": "2026-01-02T00:00:00.000Z", "endDate": null, "createdOn": "2026-01-15T09:00:00.000Z", "lastSeen": "2026-02-10T16:45:00.000Z", "firstLogin": "2026-01-15T09:18:06.809Z", "phoneNumber": "+44 7700 900789", "address": { "name": "", "number": "10", "street1": "Example Road", "street2": "", "suburb": "York", "state": "", "postcode": "EX1 1AB" }, "allergies": "None", "hasAllergies": "no", "home": "5a1174a35dcb0e004030a28d", "homes": [ "5a1174a35dcb0e004030a28d" ], "permissions": [ "residents:read", "logs:read" ], "permissionsTemplate": "care-home-admin", "medicationPermission": true, "gpConnectPermission": false, "zones": [ "Oak Wing" ], "allZones": false, "workProfile": { "contractType": "fullTime", "contractedHoursPerWeek": 37.5, "contractNotes": "", "rotaPreferenceNotes": "Prefers day shifts", "canDoOvertime": true, "availableTransportation": [ "car" ], "availability": {} }, "hasRequestedDemo": false, "picture": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/users/example-user-id/avatar.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260115%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "summary": "Experienced care home administrator.", "resident": null, "emergencyContactName": { "first": "John", "last": "Smith" }, "emergencyContactRelation": "Spouse", "emergencyContactNumber": "+44 7700 900999" } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "User not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "User with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid user ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] }, { "bearer": [] } ], "summary": "Get user by ID", "tags": [ "Modules / Users" ] }, "put": { "operationId": "updateUser", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the user", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserDto" } } } }, "responses": { "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "User not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "User with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid user ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "409": { "description": "User with this email or externalSource already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Update user", "tags": [ "Modules / Users" ] } }, "/api/careplans": { "get": { "description": "\n

Retrieves care plans with goals, assessments, documents, and tracking information.

\n

Filters:

\n\n", "operationId": "getCarePlans", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "resident-456-def", "type": "string" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on for care plan records", "schema": { "$ref": "#/components/schemas/CarePlanDateField" } }, { "name": "carePlanId", "required": false, "in": "query", "description": "Filter care plans by care plan ID", "schema": { "maxLength": 100, "example": "CP-2024-001", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarePlanResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get care plans", "tags": [ "Modules / Care Plans" ] } }, "/api/careplans/{id}": { "get": { "description": "\n

Retrieves a complete care plan including goals, assessments, documents, risk assessments, and review history.

\n", "operationId": "getCarePlanById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the care plan", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved care plan", "content": { "application/json": { "schema": { "example": { "id": "697b6a5b943a178423a9264b", "name": "Enhanced Mobility Care Plan", "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson", "full": "Margaret Thompson" }, "preferredName": "Maggie" }, "editedBy": { "id": "68406c31e55ca6b6d2262f56", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "goals": [ "6968bf21c441cf6fb4ac9a3e" ], "needs": "Requires support with mobility and transfers.", "strengths": "Motivated to remain independent; engages well with physiotherapy.", "reviewComment": "Progressing well, continue current plan.", "nextReviewDate": "2026-04-29T00:00:00.000Z", "editedOn": "2026-02-01T11:00:00.000Z", "createdOn": "2026-01-29T14:10:35.209Z", "isCustom": true, "outcomes": "Maintain independent mobility within the home.", "sections": [ { "title": "Mobility", "needs": "Requires assistance with transfers and walking longer distances.", "strengths": "Able to walk short distances with a frame.", "outcomes": "Walk to the dining room with minimal assistance." } ], "documents": [ "6977686fc18f55207654e609" ], "revisions": 1, "carePlanId": "5f213e77cdd809d04ba664be", "isRevision": false, "skillNeeds": [ "68cae49a5df0b900121771f2" ], "subActivity": "Transfers", "fluidTracking": { "enabled": true, "intakeTarget": 1500 }, "riskAssessments": [ "696f910b62d69cb14944bd29" ], "noIdentifiedNeed": false, "noFurtherSupportRequired": false } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Care Plan not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Care Plan with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid care plan ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get care plan by ID", "tags": [ "Modules / Care Plans" ] } }, "/api/homes": { "get": { "description": "\n

Retrieves care homes with facility details, ODS code, address, bed capacity, features, and home group.

\n

Filters:

\n\n", "operationId": "getHomes", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get homes", "tags": [ "Modules / Homes" ] } }, "/api/homes/{id}": { "get": { "description": "\n

Retrieves complete care home information including ODS code, address, bed capacity, home group, rota settings, and feature flags.

\n", "operationId": "getHomeById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the home", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved home", "content": { "application/json": { "schema": { "example": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home", "active": true, "address": { "postcode": "EX1 1AB", "state": null, "street1": "123 Example Street", "suburb": "Exampletown", "isPrevious": false, "isCurrent": true, "country": "United Kingdom" }, "odsCode": "EX001", "incidentSeverity": { "1": "Minor", "2": "Moderate", "3": "Significant", "4": "Serious", "5": "Major" }, "telephone": "+44 1632 960456", "bedCapacity": 45, "countryCode": "ENG", "preferredPeopleNominative": "Residents", "preferredCarePlansNominative": "Care Plans", "homeGroup": { "id": "5f155c4ac49007031a671d4e", "name": "Sunrise Care Group" }, "logCategoryItems": [ { "id": "5e81db67b1b4e673bc2bb8cc", "name": "Catheter" } ], "familyLogCategoryItems": [ { "id": "68cae49a5df0b900121771f2", "name": "Activities" } ], "picture": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/home/example-home-id/home.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260720%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260720T085642Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "showAllResidentsButton": true, "visitBasedAccessControl": false, "startAccessTimeValue": 1, "startAccessTimeUnit": "hours", "endAccessTimeValue": 1, "endAccessTimeUnit": "hours", "sortByRoomNumber": true, "familyCarePlans": true, "familyDocuments": true, "familyShowNames": true, "familyShowDates": true, "locations": [ "Oak Wing", "Maple Wing" ], "tier": "premium", "careSetting": "residential", "serviceUserType": "olderPeople", "secondaryCareSetting": "nursing", "secondaryServiceUserType": "dementia", "rotaSettings": { "flexiVisits": false, "fundingTypesCount": 3, "contractTypesCount": 2, "absenceTypesCount": 4, "shiftTypesCount": 5, "visitTypesCount": 0 }, "privacyOfficers": [ { "id": "507f1f77bcf86cd799439022", "name": "Jane Smith", "email": "jane.smith@example.com", "startDate": "2026-01-15T00:00:00.000Z" } ], "features": { "deviceAccessControl": { "granted": true, "enabled": true }, "eMAR": { "granted": true, "enabled": false }, "family": { "granted": true, "enabled": true }, "geoLocation": { "granted": false, "enabled": false }, "rota": { "granted": true, "enabled": true }, "noticeBoard": { "granted": true, "enabled": true }, "positiveBehaviour": { "granted": false, "enabled": false } }, "createdOn": "2026-07-20T08:56:42.725Z" } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Home not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Home with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid home ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get home by ID", "tags": [ "Modules / Homes" ] } }, "/api/incident-reports": { "get": { "description": "\n

Retrieves incident reports with severity, status, case details, and investigation notes.

\n

Filters:

\n\n", "operationId": "getIncidentReports", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "resident-456-def", "type": "string" } }, { "name": "severity", "required": false, "in": "query", "description": "Filter by severity level (1=lowest, 5=highest)", "schema": { "example": 2, "type": "number", "enum": [ 1, 2, 3, 4, 5 ] } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on (created_on, closed_on, reviewed_on, or ingested_on)", "schema": { "default": "ingested_on", "example": "ingested_on", "type": "string", "enum": [ "created_on", "closed_on", "reviewed_on", "ingested_on" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentReportResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get incident reports", "tags": [ "Modules / Incident Reports" ] } }, "/api/incident-reports/{id}": { "get": { "description": "\n

Retrieves complete incident details including log, case information, witnesses, actions taken, and closure notes.

\n", "operationId": "getIncidentReportById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the incident report", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved incident report", "content": { "application/json": { "schema": { "example": { "id": "6980aa75a5429846498a40da", "createdOn": "2026-04-09T18:48:00.000Z", "log": { "title": "Safeguarding", "description": "Resident reported feeling unsafe in the garden area. Staff responded immediately and documented the incident.", "timeLogged": "2026-04-09T18:48:00.000Z", "location": "Garden" }, "case": null, "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987b2", "name": { "first": "David", "last": "Williams", "full": "David Williams" } }, "status": "needsReview", "closedBy": null, "closedOn": null, "severity": 2, "isDeleted": false, "reviewedOn": null, "closeComment": null, "category": { "id": "5e867702b349f776c8d48c34", "name": "Incident", "icon": "https://lmc-data-production.s3.eu-west-2.amazonaws.com/icons/qXxuGVYsSRgAcXoZ.png", "color": "#FF3366" }, "item": { "id": "68cae49a5df0b900121771f2", "name": "Safeguarding", "icon": "https://lmc-data-production.s3.eu-west-2.amazonaws.com/icons/DrpQZb2rGf1HHvuI.png" } } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Incident Report not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Incident Report with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid incident report ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get incident report by ID", "tags": [ "Modules / Incident Reports" ] } }, "/api/goals": { "get": { "description": "\n

Retrieves care goals with objectives, progress tracking, action plans, success measurements, and review history.

\n

Filters:

\n\n", "operationId": "getGoals", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "resident-456-def", "type": "string" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on", "schema": { "default": "created_on", "example": "created_on", "type": "string", "enum": [ "created_on", "edited_on", "start_date", "end_date", "ingested_on" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoalResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get goals", "tags": [ "Modules / Goals" ] } }, "/api/goals/{id}": { "get": { "description": "\n

Retrieves complete goal details including objectives, progress history, action plans, logs, and success measurements.

\n", "operationId": "getGoalById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the goal", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved goal", "content": { "application/json": { "schema": { "example": { "id": "6968bf21c441cf6fb4ac9a3e", "home": { "id": "home-123-abc", "name": "Sunrise Care Home" }, "resident": { "id": "resident_id_123", "name": { "first": "John", "last": "Doe", "full": "John Doe" } }, "createdBy": { "id": "user_id_789", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "editedBy": { "id": "user_id_790", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "logs": [ "6968bf21c441cf6fb4ac9a3f", "696f874462d69cb149439f25" ], "title": "Improve Mobility", "seenBy": [], "status": "notStarted", "actions": [], "endDate": "2026-06-30T00:00:00.000Z", "editedOn": "2026-01-23T14:18:42.514Z", "createdOn": "2026-01-15T10:30:00.000Z", "startDate": "2026-01-15T00:00:00.000Z", "importance": 8, "description": "Increase independent walking distance to 50 meters", "nextReviewDate": "2026-03-30T00:00:00.000Z", "progressHistory": [ { "date": "2026-01-15T10:19:13.900Z", "progress": 0 } ], "successMeasurement": "Able to walk 50 meters independently" } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Goal not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Goal with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid goal ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get goal by ID", "tags": [ "Modules / Goals" ] } }, "/api/risk-assessments": { "get": { "description": "\n

Retrieves risk assessments with safety evaluations, hazard identification, risk scores, and mitigation strategies.

\n

Filters:

\n\n", "operationId": "getRiskAssessments", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "resident-456-def", "type": "string" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on", "schema": { "default": "created_on", "example": "created_on", "type": "string", "enum": [ "created_on", "reviewed_on", "ingested_on" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskAssessmentResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get risk assessments", "tags": [ "Modules / Risk Assessments" ] } }, "/api/risk-assessments/{id}": { "get": { "description": "\n

Retrieves complete risk assessment details including form data, risk scores, review history, and assessor information.

\n", "operationId": "getRiskAssessmentById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the risk assessment", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved risk assessment", "content": { "application/json": { "schema": { "example": { "id": "696f910b62d69cb14944bd29", "form": { "id": "6960cb5add702a0011af4ce2", "name": "", "formFields": [] }, "home": { "id": "home-123-abc", "name": "Sunrise Care Home" }, "resident": { "id": "resident_id_123", "name": { "first": "John", "last": "Doe", "full": "John Doe" }, "preferredName": "Johnny" }, "createdBy": { "id": "user_id_789", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "seenBy": [], "archived": false, "createdOn": "2026-01-20T14:28:27.400Z", "riskLevel": "high", "riskScore": 12, "incomplete": false, "reviewedOn": "2026-01-20T14:28:27.401Z" } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Risk Assessment not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Risk Assessment with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid risk assessment ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get risk assessment by ID", "tags": [ "Modules / Risk Assessments" ] } }, "/api/logs": { "get": { "description": "\n

Retrieves logs (daily care notes) logged by staff members about residents' care, activities, and observations.

\n

Filters:

\n\n

Note: Deleted logs are automatically excluded from results.

\n", "operationId": "getLogs", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "63299b624e4c26570fe21e75", "type": "string" } }, { "name": "categoryId", "required": false, "in": "query", "description": "Filter by log category ID", "schema": { "example": "5f155c4ac49007031a671d4f", "type": "string" } }, { "name": "itemId", "required": false, "in": "query", "description": "Filter by log category item ID", "schema": { "example": "5f155c4ac49007031a671d50", "type": "string" } }, { "name": "loggedById", "required": false, "in": "query", "description": "Filter by user who logged (loggedBy)", "schema": { "example": "68ef4775c1e051de495b175a", "type": "string" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on (only timeLogged supported)", "schema": { "default": "timeLogged", "example": "timeLogged", "type": "string", "enum": [ "timeLogged" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get logs (daily care notes)", "tags": [ "Modules / Logs" ] } }, "/api/logs/{id}": { "get": { "description": "\n

Retrieves complete log information including populated references for home, resident, loggedBy, editedBy, category, and item.

\n

Logs represent daily care notes and observations logged by staff members.

\n", "operationId": "getLogById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the log", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved log", "content": { "application/json": { "schema": { "example": { "id": "6980bf40b0d86defd672b8a1", "title": "Resident had a good breakfast", "type": "log", "timeLogged": "2026-02-02T15:14:02.272Z", "originalTimeLog": "2026-02-02T15:14:08.625Z", "description": "Ate all food, engaged in conversation with other residents. No assistance required.", "location": "Dining Room", "deleted": false, "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson", "full": "Margaret Thompson" } }, "loggedBy": { "id": "68406c31e55ca6b6d2262f56", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "editedBy": { "id": "68ef4775c1e051de495b175a", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "category": { "id": "5e867702b349f776c8d48c34", "name": "Food & Drink" }, "item": { "id": "68cae49a5df0b900121771f2", "name": "Breakfast" }, "editedAt": "2026-02-02T15:20:00.000Z", "revisions": 0, "picture1": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/home/logs/example-home-id/photo1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260202%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260202T151402Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "picture2": null, "picture3": null, "videoFile": null, "videoThumbnail": null, "hidden": false, "isNextHandover": false, "revoked": false, "revokedAt": null, "nonEditable": false, "amount1": 250, "amount2": 0, "amountType": "ml", "stockQuantityType": "volume", "latitude": 51.5, "longitude": -1.5, "accuracy": 10, "itemSublevel": "Lunch", "doneBySu": false, "response": { "questions": [ { "key": "mood", "label": "Mood", "value": "Happy" } ] } } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Log not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Log with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid log ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get log by ID", "tags": [ "Modules / Logs" ] } }, "/api/logcategories": { "get": { "description": "\n

Retrieves log categories used to classify daily care notes and observations.

\n

Examples: Meals & Nutrition, Personal Care, Activities, Health & Wellbeing, Medication

\n

Filters:

\n\n

Note: This endpoint does not require authentication. Log categories are public reference data.

\n", "operationId": "getLogCategories", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } } ], "responses": { "200": { "description": "List of log categories", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogCategoryResponseDto" } } } } }, "summary": "Get log categories", "tags": [ "Modules / Log Categories" ] } }, "/api/logcategories/{id}": { "get": { "description": "\n

Retrieves a log category with its id, name, and color.

\n

Log categories are used to organize and classify daily care logs.

\n

Note: This endpoint does not require authentication.

\n", "operationId": "getLogCategoryById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the logcategory", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Log category details", "content": { "application/json": { "schema": { "example": { "id": "5f213e77cdd809d04ba664be", "name": "Body Maps", "color": "#9966FB" } } } } } }, "summary": "Get log category by ID", "tags": [ "Modules / Log Categories" ] } }, "/api/logcategoryitems": { "get": { "description": "\n

Retrieves log category items representing specific activities or observations within a log category.

\n

Examples: Breakfast (under Meals & Nutrition), Shower (under Personal Care), Walk in Garden (under Activities)

\n

Filters:

\n\n

Note: This endpoint does not require authentication. Items are sorted by order for proper UI display.

\n", "operationId": "getLogCategoryItems", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } } ], "responses": { "200": { "description": "List of log category items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogCategoryItemResponseDto" } } } } }, "summary": "Get log category items", "tags": [ "Modules / Log Category Items" ] } }, "/api/logcategoryitems/{id}": { "get": { "description": "\n

Retrieves a log category item with its id, name, and parent category id.

\n

Log category items represent specific activities or observations that can be logged by staff members.

\n

Note: This endpoint does not require authentication.

\n", "operationId": "getLogCategoryItemById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the logcategoryitem", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Log category item details", "content": { "application/json": { "schema": { "example": { "id": "5e81db67b1b4e673bc2bb8cc", "name": "Catheter", "category": "5e867702b349f776c8d48c2f" } } } } } }, "summary": "Get log category item by ID", "tags": [ "Modules / Log Category Items" ] } }, "/api/documents": { "get": { "description": "\n

Retrieves resident-specific documents including medical records, assessments, care plans, and other resident documentation.

\n

Filters:

\n\n", "operationId": "getDocuments", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "63299b624e4c26570fe21e75", "type": "string" } }, { "name": "categoryId", "required": false, "in": "query", "description": "Filter by document category ID", "schema": { "example": "5f155c4ac49007031a671d4f", "type": "string" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on (only createdAt supported)", "schema": { "default": "createdAt", "example": "createdAt", "type": "string", "enum": [ "createdAt" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get documents (resident documents)", "tags": [ "Modules / Documents" ] } }, "/api/documents/{id}": { "get": { "description": "\n

Retrieves complete document information including file details, category, resident, and home references.

\n

Documents represent files uploaded for specific residents, including PDFs and other file types.

\n", "operationId": "getDocumentById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the document", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved document", "content": { "application/json": { "schema": { "example": { "id": "6977686fc18f55207654e609", "name": "Medical Assessment - January 2026", "createdAt": "2026-01-26T13:13:19.529Z", "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson", "full": "Margaret Thompson" } }, "category": { "id": "5f155c4ac49007031a671d4f", "name": "Care Plans" }, "pdf": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/docs/home/documents/example-home-id/document-file.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260126%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260126T131319Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "originalFile": "Medical_Assessment_Jan2026.pdf", "attachedToCarePlan": true } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Document not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Document with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid document ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get document by ID", "tags": [ "Modules / Documents" ] } }, "/api/home-documents": { "get": { "description": "\n

Retrieves home-scoped documents including policies, procedures, licenses, training materials, and other home-level documentation.

\n

Filters:

\n\n", "operationId": "getHomeDocuments", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "homeId", "required": false, "in": "query", "description": "Filter by home ID", "schema": { "example": "home-123-abc", "type": "string" } }, { "name": "residentId", "required": false, "in": "query", "description": "Filter by resident ID", "schema": { "example": "resident-456-def", "type": "string" } }, { "name": "categoryId", "required": false, "in": "query", "description": "Filter by home document category ID", "schema": { "example": "5f155c4ac49007031a671d4f", "type": "string" } }, { "name": "dateField", "required": false, "in": "query", "description": "Date field to filter on (only createdAt supported)", "schema": { "default": "createdAt", "example": "createdAt", "type": "string", "enum": [ "createdAt" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDocumentResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get home documents (home-scoped documents)", "tags": [ "Modules / Home Documents" ] } }, "/api/home-documents/{id}": { "get": { "description": "\n

Retrieves complete home document information including file details, category, and home references.

\n

Home documents are scoped to care homes rather than individual residents, including policies, procedures, and licenses.

\n", "operationId": "getHomeDocumentById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the home document", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved homedocument", "content": { "application/json": { "schema": { "example": { "id": "6915ffc2e924f18fb5af8879", "name": "Fire Safety Policy - 2026", "createdAt": "2026-11-13T15:56:50.600Z", "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "category": { "id": "5f155c4ac49007031a671d4f", "name": "General" }, "pdf": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/docs/home/homeDocuments/example-home-id/document-file.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260113%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260113T155650Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "originalFile": "Fire_Safety_Policy_2026.pdf" } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "HomeDocument not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "HomeDocument with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid homedocument ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get home document by ID", "tags": [ "Modules / Home Documents" ] } }, "/api/devices": { "get": { "description": "\n

Retrieves devices (tablets, phones, laptops) registered to care homes for logging activities.

\n

All ObjectId reference fields are populated one level deep with { id, name }.

\n

The homes array in the response is filtered to only include entries for homes the API key has access to.

\n

Filters:

\n\n", "operationId": "getDevices", "parameters": [ { "name": "startDate", "required": false, "in": "query", "description": "Start date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-01-01", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "End date for filtering (inclusive)", "schema": { "format": "date", "example": "2026-12-31", "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Page number (1-based)", "schema": { "minimum": 1, "default": 1, "example": 1, "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "Number of records per page", "schema": { "minimum": 1, "maximum": 100, "default": 10, "example": 10, "type": "number" } }, { "name": "type", "required": false, "in": "query", "description": "Filter by device type", "schema": { "example": "tablet", "type": "string", "enum": [ "tablet", "phone", "laptop" ] } }, { "name": "deviceStatus", "required": false, "in": "query", "description": "Filter by device home assignment status. If not provided, returns devices with any status.", "schema": { "example": "approved", "type": "string", "enum": [ "pending", "approved", "blocked" ] } } ], "responses": { "200": { "description": "Successfully retrieved records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceResponseDto" } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get devices", "tags": [ "Modules / Devices" ] } }, "/api/devices/{id}": { "get": { "description": "\n

Retrieves complete device information including populated user references, home assignments with status, and audit fields.

\n

The homes array is filtered to only include entries for homes the API key has access to. FCM (push notification) fields are excluded from the response.

\n", "operationId": "getDeviceById", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Unique identifier of the device", "schema": { "example": "64f8a1b23d4e5f6a7b8c9d0e", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved device", "content": { "application/json": { "schema": { "example": { "id": "64f8a1b23d4e5f6a7b8c9d0e", "name": "Reception Tablet", "uuid": "550e8400-e29b-41d4-a716-446655440000", "version": "4.2.1", "model": "iPad Pro 12.9", "type": "tablet", "users": [ { "id": "64f8a1b23d4e5f6a7b8c9d01", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } } ], "homes": [ { "home": { "id": "64f8a1b23d4e5f6a7b8c9d02", "name": "Sunrise Care Home" }, "status": "approved" } ], "lastUsedBy": { "id": "64f8a1b23d4e5f6a7b8c9d01", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "lastUsedOn": "2026-03-07T14:30:00.000Z", "createdBy": { "id": "64f8a1b23d4e5f6a7b8c9d03", "name": { "first": "Admin", "last": "User", "full": "Admin User" } }, "createdOn": "2026-01-15T10:00:00.000Z", "editedBy": { "id": "64f8a1b23d4e5f6a7b8c9d01", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "editedOn": "2026-03-07T14:30:00.000Z" } } } } }, "400": { "description": "Invalid query parameters", "schema": { "example": { "error": { "code": "VALIDATION_ERROR", "message": "Invalid query parameters", "details": { "field": "startDate", "provided": "invalid-date", "expected": "ISO 8601 format (YYYY-MM-DD)" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12345" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Authentication required or invalid credentials", "schema": { "example": { "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Invalid or expired JWT token", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12346" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Insufficient permissions", "schema": { "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient permissions to access this resource", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12349" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Device not found", "schema": { "example": { "error": { "code": "NOT_FOUND", "message": "Device with ID '64f8a1b23d4e5f6a7b8c9d0e' not found", "details": { "field": "id", "provided": "64f8a1b23d4e5f6a7b8c9d0e", "expected": "Valid device ID" }, "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12348" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "500": { "description": "Internal server error", "schema": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred", "timestamp": "2026-12-11T10:30:00Z", "correlationId": "req_12347" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [] } ], "summary": "Get device by ID", "tags": [ "Modules / Devices" ] } } }, "info": { "title": "Log my Care Open API", "description": "API for accessing Log my Care data. Most endpoints are read-only (GET); the Residents endpoint additionally supports creating and updating records (POST/PUT). Authenticate by exchanging your API key for a JWT token via POST /openapi/auth/token/exchange, then include the token in the Authorization: Bearer header.\n\n

Authentication

\n\n

Token Exchange (Required): Exchange the API key for a short-lived JWT token (15 minutes) using POST /openapi/auth/token/exchange. This provides enhanced security by minimizing API key exposure.

\n\n

All authenticated endpoints require a valid JWT token in the Authorization: Bearer header.

\n\n

Available Endpoints

\n\n

Health & Status

\n\n\n

Residents

\n\n\n

Care Plans

\n\n\n

Goals

\n\n\n

Incident Reports

\n\n\n

Risk Assessments

\n\n\n

Homes

\n\n\n

Users

\n\n\n

Logs

\n\n\n

Log Categories

\n\n\n

Log Category Items

\n\n\n

Documents

\n\n\n

Home Documents

\n\n\n

Devices

\n\n\n

Common Features

\n\n

Pagination: All list endpoints support page (default: 1) and limit (default: 10, max: 100) parameters.

\n\n

Date Filtering: Many endpoints support startDate, endDate, and dateField parameters for filtering by date ranges.

\n\n

Rate limits: 100 requests/minute per IP (unauthenticated), 1,000 requests/minute with JWT token authentication.

\n\n

Security: All requests logged, input validated, parameterised queries, rate limiting enforced.

", "version": "1.100.0", "contact": { "name": "API Support", "email": "support@logmycare.co.uk" } }, "tags": [ { "name": "health", "description": "Health check and system status" }, { "name": "token-exchange", "description": "API key authentication" }, { "name": "Modules / Residents", "description": "Resident records" }, { "name": "Modules / Users", "description": "User records" }, { "name": "Modules / Care Plans", "description": "Care plan records" }, { "name": "Modules / Homes", "description": "Care home records" }, { "name": "Modules / Incident Reports", "description": "Incident report records" }, { "name": "Modules / Goals", "description": "Goal records" }, { "name": "Modules / Risk Assessments", "description": "Risk assessment records" }, { "name": "Modules / Logs", "description": "Daily care log records" }, { "name": "Modules / Log Categories", "description": "Log category records" }, { "name": "Modules / Log Category Items", "description": "Log category item records" }, { "name": "Modules / Documents", "description": "Resident document records" }, { "name": "Modules / Home Documents", "description": "Home-scoped document records" }, { "name": "Modules / Devices", "description": "Device records" } ], "servers": [ { "url": "https://data.logmycare.co.uk/openapi", "description": "API Server" } ], "components": { "securitySchemes": { "Bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "JWT token obtained from token exchange endpoint" } }, "schemas": { "TokenExchangeRequestDto": { "type": "object", "properties": { "grant_type": { "type": "string", "description": "Grant type for token exchange", "enum": [ "api_key_exchange" ], "example": "api_key_exchange" }, "api_key": { "type": "string", "description": "API key to exchange for access token. The API key in MongoDB defines all permissions, scopes, and home access.", "example": "sk_live_abcd1234...", "minLength": 8 } }, "required": [ "grant_type", "api_key" ] }, "TokenExchangeResponseDto": { "type": "object", "properties": { "access_token": { "type": "string", "description": "Short-lived JWT access token", "example": "eyJhbGciOiJIUzI1NiI..." }, "token_type": { "type": "string", "description": "Token type", "enum": [ "Bearer" ], "example": "Bearer" }, "expires_in": { "type": "number", "description": "Token expiration time in seconds", "example": 900 }, "scope": { "description": "Granted permissions/scope", "example": [ "residents:read", "careplans:read" ], "type": "array", "items": { "type": "string" } }, "issued_token_type": { "type": "string", "description": "Type of issued token", "example": "urn:ietf:params:oauth:token-type:jwt" } }, "required": [ "access_token", "token_type", "expires_in", "scope", "issued_token_type" ] }, "TokenExchangeErrorDto": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code", "example": "invalid_request" }, "error_description": { "type": "string", "description": "Human-readable error description", "example": "Invalid API key" }, "error_details": { "type": "object", "description": "Additional error details", "example": { "field": "api_key", "code": "invalid" } } }, "required": [ "error", "error_description" ] }, "RateLimitErrorDto": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code", "example": "rate_limit_exceeded" }, "error_description": { "type": "string", "description": "Human-readable error description", "example": "API key exchange rate limit exceeded" }, "retry_after": { "type": "number", "description": "Seconds until next request is allowed", "example": 45 }, "limits": { "type": "object", "description": "Current rate limit status", "example": { "per_minute": { "limit": 2, "remaining": 0, "reset": 1694438445 }, "per_hour": { "limit": 10, "remaining": 3, "reset": 1694441045 }, "per_day": { "limit": 50, "remaining": 23, "reset": 1694524845 } } } }, "required": [ "error", "error_description", "retry_after", "limits" ] }, "PaginationMetaDto": { "type": "object", "properties": { "page": { "type": "number", "description": "Current page number", "example": 1 }, "limit": { "type": "number", "description": "Number of records per page", "example": 10 }, "total": { "type": "object", "description": "Total number of records. Shows '10000+' when count exceeds 10,000 for performance optimization.", "example": 150, "examples": { "exact": { "summary": "Exact count", "value": 150 }, "capped": { "summary": "Capped at 10,000", "value": "10000+" } } }, "totalPages": { "type": "number", "description": "Total number of pages", "example": 15 }, "hasNext": { "type": "boolean", "description": "Whether there is a next page", "example": true }, "hasPrev": { "type": "boolean", "description": "Whether there is a previous page", "example": false } }, "required": [ "page", "limit", "total", "totalPages", "hasNext", "hasPrev" ] }, "ResidentResponseDto": { "type": "object", "properties": { "data": { "description": "Array of residents", "example": [ { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson" }, "email": "margaret.thompson@example.com", "gender": "female", "dateOfBirth": "1945-06-15T00:00:00.000Z", "createdOn": "2026-01-15T09:30:00.000Z", "admissionDate": "2026-01-10T00:00:00.000Z", "preferredName": "Maggie", "status": "active", "statusChangedOn": "2026-01-20T10:00:00.000Z", "isInactive": false, "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "location": { "roomName": "Room 12", "unit": "Oak Wing", "floor": "1" }, "nhsNumber": "999 000 0001", "bloodType": "O+", "allergies": "Penicillin", "hasAllergies": true, "noKnownAllergies": false, "residentAllergies": [ "Penicillin", "Latex" ], "medicalHistory": "Hypertension, Type 2 diabetes", "height": "165cm", "gpCode": "G1234567", "gpName": "Dr. Sarah Williams", "gpEmail": "sarah.williams@nhs.example.com", "gpTelephone": "+44 1632 960123", "gpAddress": { "street1": "1 Example Lane", "suburb": "Exampletown", "postcode": "EX1 1CD", "country": "United Kingdom" }, "gpSurgeryName": "Example Medical Practice", "phones": [ { "number": "+44 7700 900123", "type": "mobile" } ], "addresses": [ { "street1": "45 Example Avenue", "suburb": "Exampletown", "postcode": "EX1 1EF", "country": "United Kingdom", "isCurrent": true, "isPrevious": false } ], "importantContacts": [ { "name": { "first": "Robert", "last": "Thompson" }, "relationship": "Son", "nextOfKin": true, "lpa": true, "phone": "+44 7700 900456", "email": "robert.thompson@example.com", "addresses": [ { "street1": "1 Example Street", "suburb": "Leeds", "postcode": "EX1 1EX", "country": "United Kingdom" } ] } ], "preferredContactMethod": "noPreference", "religion": "Christian", "ethnicity": "White British", "nationality": "British", "nationalities": [ "British" ], "languagesSpoken": [ "English" ], "maritalStatus": "widowed", "birthplace": "York", "sexualPreference": "heterosexual", "carePackage": { "fundingSource": "localAuthority", "fundingSourceNotes": "Funded by York City Council", "fundingSourceOther": "" }, "fundingSource": "localAuthority", "fundingSourceNotes": "Funded by York City Council", "fundingSourceOther": "", "keyworkers": [ "68406c31e55ca6b6d2262f56" ], "carerPreferences": { "gender": "female", "language": "English" }, "preferredDrink": "Tea with milk", "preferredAdminRoute": "oral", "dols": { "status": "authorised", "startDate": "2026-02-01T00:00:00.000Z", "endDate": "2026-08-01T00:00:00.000Z", "reviewDate": "2026-05-01T00:00:00.000Z", "applicationDate": "2026-01-15T00:00:00.000Z" }, "dolsStartDate": "2026-02-01T00:00:00.000Z", "dolsEndDate": "2026-08-01T00:00:00.000Z", "dolsReviewDate": "2026-05-01T00:00:00.000Z", "dolsApplicationDate": "2026-01-15T00:00:00.000Z", "dnacpr": { "hasDnacpr": true, "details": "DNACPR in place, reviewed by GP", "reviewDate": "2026-06-01T00:00:00.000Z", "formPhysicalLocation": "Front of care file" }, "dnacprDetails": "DNACPR in place, reviewed by GP", "dnacprReviewDate": "2026-06-01T00:00:00.000Z", "dnacprFormPhysicalLocation": "Front of care file", "recentMustScore": "1", "recentWaterlowScore": "12", "recentDrinkConsumption": "1500ml", "hasChokingRisk": false, "prnMedsNote": "Paracetamol PRN for pain", "nationalInsurance": "QQ123456C", "summary": "Margaret is a friendly resident who enjoys gardening and reading.", "otherIdentifiers": [ { "type": "localAuthorityRef", "value": "LA-2026-0042" } ], "ageYears": 80 } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "ErrorDetailDto": { "type": "object", "properties": { "field": { "type": "string", "description": "Field that caused the error", "example": "startDate" }, "provided": { "type": "string", "description": "Value that was provided", "example": "invalid-date" }, "expected": { "type": "string", "description": "Expected format or value", "example": "ISO 8601 format (YYYY-MM-DD)" } }, "required": [ "field", "provided", "expected" ] }, "ErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": "VALIDATION_ERROR", "enum": [ "AUTHENTICATION_REQUIRED", "RATE_LIMIT_EXCEEDED", "VALIDATION_ERROR", "NOT_FOUND", "DATABASE_ERROR", "INTERNAL_ERROR", "METHOD_NOT_ALLOWED" ] }, "message": { "type": "string", "description": "Error message", "example": "Invalid date format" }, "details": { "description": "Additional error details", "allOf": [ { "$ref": "#/components/schemas/ErrorDetailDto" } ] }, "timestamp": { "type": "string", "description": "ISO 8601 timestamp of when the error occurred", "example": "2025-09-10T10:30:00Z" }, "correlationId": { "type": "string", "description": "Correlation ID for tracking", "example": "req_12345" } }, "required": [ "code", "message", "timestamp", "correlationId" ] }, "ErrorResponseDto": { "type": "object", "properties": { "error": { "description": "Error information", "allOf": [ { "$ref": "#/components/schemas/ErrorDto" } ] } }, "required": [ "error" ] }, "ResidentNameDto": { "type": "object", "properties": { "first": { "type": "string", "example": "Jane" }, "last": { "type": "string", "example": "Smith" }, "full": { "type": "string", "example": "Jane Smith" } }, "required": [ "first", "last" ] }, "ExternalSourceDto": { "type": "object", "properties": { "sourceName": { "type": "string", "example": "my-integration", "description": "Name of the external system" }, "sourceId": { "type": "string", "example": "ext-12345", "description": "Unique identifier in the external system" }, "sourceType": { "type": "string", "example": "api", "description": "Type of the record in the external system", "enum": [ "api", "import", "integration" ] }, "externalCreatedAt": { "type": "string", "example": "2024-01-15T09:30:00.000Z", "description": "When the record was created in the external system (ISO 8601)" }, "sourceRecordUrl": { "type": "string", "example": "https://app.example.com/residents/ext-12345", "description": "URL to the record in the external system" }, "metadata": { "type": "object", "example": { "region": "north", "ward": "A" }, "description": "Additional metadata from the external system" } }, "required": [ "sourceName", "sourceId", "sourceType" ] }, "CreateResidentDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/ResidentNameDto" }, "home": { "type": "string", "example": "507f1f77bcf86cd799439011", "description": "Home ID" }, "dateOfBirth": { "type": "string", "example": "1945-06-15", "description": "ISO 8601 date" }, "gender": { "type": "string", "enum": [ "male", "female", "any", "unknown", "unspecified", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "hospitalised", "deceased", "discharged", "pre-assessment", "dummy" ] }, "externalSource": { "$ref": "#/components/schemas/ExternalSourceDto" } }, "required": [ "name", "home", "dateOfBirth" ] }, "UpdateResidentDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/ResidentNameDto" }, "dateOfBirth": { "type": "string", "example": "1945-06-15", "description": "ISO 8601 date" }, "gender": { "type": "string", "enum": [ "male", "female", "any", "unknown", "unspecified", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "hospitalised", "deceased", "discharged", "pre-assessment", "dummy" ] }, "preferredName": { "type": "string", "example": "Jen" }, "externalSource": { "$ref": "#/components/schemas/ExternalSourceDto" } } }, "UserResponseDto": { "type": "object", "properties": { "data": { "description": "Array of users", "example": [ { "id": "68406c31e55ca6b6d2262f56", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" }, "email": "jane.smith@example.co.uk", "role": "carehome-admin", "cernerRole": "standard", "active": true, "deleted": false, "dateOfBirth": "1985-03-22T00:00:00.000Z", "startDate": "2026-01-02T00:00:00.000Z", "endDate": null, "createdOn": "2026-01-15T09:00:00.000Z", "lastSeen": "2026-02-10T16:45:00.000Z", "firstLogin": "2026-01-15T09:18:06.809Z", "phoneNumber": "+44 7700 900789", "address": { "name": "", "number": "10", "street1": "Example Road", "street2": "", "suburb": "York", "state": "", "postcode": "EX1 1AB" }, "allergies": "None", "hasAllergies": "no", "home": "5a1174a35dcb0e004030a28d", "homes": [ "5a1174a35dcb0e004030a28d" ], "permissions": [ "residents:read", "logs:read" ], "permissionsTemplate": "care-home-admin", "medicationPermission": true, "gpConnectPermission": false, "zones": [ "Oak Wing" ], "allZones": false, "workProfile": { "contractType": "fullTime", "contractedHoursPerWeek": 37.5, "contractNotes": "", "rotaPreferenceNotes": "Prefers day shifts", "canDoOvertime": true, "availableTransportation": [ "car" ], "availability": {} }, "hasRequestedDemo": false, "picture": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/users/example-user-id/avatar.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260115%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "summary": "Experienced care home administrator.", "resident": null, "emergencyContactName": { "first": "John", "last": "Smith" }, "emergencyContactRelation": "Spouse", "emergencyContactNumber": "+44 7700 900999" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "UserNameDto": { "type": "object", "properties": { "first": { "type": "string", "example": "Jane" }, "last": { "type": "string", "example": "Smith" } }, "required": [ "first", "last" ] }, "CreateUserDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/UserNameDto" }, "email": { "type": "string", "example": "jane.smith@sunrisecare.co.uk" }, "role": { "type": "string", "enum": [ "carer", "senior-carer", "carehome-admin", "management" ] }, "home": { "type": "string", "example": "507f1f77bcf86cd799439011", "description": "Primary home ID" }, "homes": { "example": [], "type": "array", "items": { "type": "string" } }, "externalSource": { "$ref": "#/components/schemas/ExternalSourceDto" } }, "required": [ "name", "email", "role", "home" ] }, "UpdateUserDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/UserNameDto" }, "email": { "type": "string", "example": "jane.smith@sunrisecare.co.uk" }, "role": { "type": "string", "enum": [ "carer", "senior-carer", "carehome-admin", "management" ] }, "active": { "type": "boolean", "example": true }, "externalSource": { "$ref": "#/components/schemas/ExternalSourceDto" } } }, "CarePlanDateField": { "type": "string", "enum": [ "created_on", "edited_on", "next_review_date", "ingested_on" ] }, "CarePlanResponseDto": { "type": "object", "properties": { "data": { "description": "Array of care plans with comprehensive care information", "example": [ { "id": "697b6a5b943a178423a9264b", "name": "Enhanced Mobility Care Plan", "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson", "full": "Margaret Thompson" }, "preferredName": "Maggie" }, "editedBy": { "id": "68406c31e55ca6b6d2262f56", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "goals": [ "6968bf21c441cf6fb4ac9a3e" ], "needs": "Requires support with mobility and transfers.", "strengths": "Motivated to remain independent; engages well with physiotherapy.", "reviewComment": "Progressing well, continue current plan.", "nextReviewDate": "2026-04-29T00:00:00.000Z", "editedOn": "2026-02-01T11:00:00.000Z", "createdOn": "2026-01-29T14:10:35.209Z", "isCustom": true, "outcomes": "Maintain independent mobility within the home.", "sections": [ { "title": "Mobility", "needs": "Requires assistance with transfers and walking longer distances.", "strengths": "Able to walk short distances with a frame.", "outcomes": "Walk to the dining room with minimal assistance." } ], "documents": [ "6977686fc18f55207654e609" ], "revisions": 1, "carePlanId": "5f213e77cdd809d04ba664be", "isRevision": false, "skillNeeds": [ "68cae49a5df0b900121771f2" ], "subActivity": "Transfers", "fluidTracking": { "enabled": true, "intakeTarget": 1500 }, "riskAssessments": [ "696f910b62d69cb14944bd29" ], "noIdentifiedNeed": false, "noFurtherSupportRequired": false } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata including total count, current page, and page size", "example": { "page": 1, "limit": 10, "total": 150, "totalPages": 15, "hasNext": true, "hasPrevious": false }, "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "HomeResponseDto": { "type": "object", "properties": { "data": { "description": "Array of homes", "example": [ { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home", "active": true, "address": { "postcode": "EX1 1AB", "state": null, "street1": "123 Example Street", "suburb": "Exampletown", "isPrevious": false, "isCurrent": true, "country": "United Kingdom" }, "odsCode": "EX001", "incidentSeverity": { "1": "Minor", "2": "Moderate", "3": "Significant", "4": "Serious", "5": "Major" }, "telephone": "+44 1632 960456", "bedCapacity": 45, "countryCode": "ENG", "preferredPeopleNominative": "Residents", "preferredCarePlansNominative": "Care Plans", "homeGroup": { "id": "5f155c4ac49007031a671d4e", "name": "Sunrise Care Group" }, "logCategoryItems": [ { "id": "5e81db67b1b4e673bc2bb8cc", "name": "Catheter" } ], "familyLogCategoryItems": [ { "id": "68cae49a5df0b900121771f2", "name": "Activities" } ], "picture": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/home/example-home-id/home.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260720%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260720T085642Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "showAllResidentsButton": true, "visitBasedAccessControl": false, "startAccessTimeValue": 1, "startAccessTimeUnit": "hours", "endAccessTimeValue": 1, "endAccessTimeUnit": "hours", "sortByRoomNumber": true, "familyCarePlans": true, "familyDocuments": true, "familyShowNames": true, "familyShowDates": true, "locations": [ "Oak Wing", "Maple Wing" ], "tier": "premium", "careSetting": "residential", "serviceUserType": "olderPeople", "secondaryCareSetting": "nursing", "secondaryServiceUserType": "dementia", "rotaSettings": { "flexiVisits": false, "fundingTypesCount": 3, "contractTypesCount": 2, "absenceTypesCount": 4, "shiftTypesCount": 5, "visitTypesCount": 0 }, "privacyOfficers": [ { "id": "507f1f77bcf86cd799439022", "name": "Jane Smith", "email": "jane.smith@example.com", "startDate": "2026-01-15T00:00:00.000Z" } ], "features": { "deviceAccessControl": { "granted": true, "enabled": true }, "eMAR": { "granted": true, "enabled": false }, "family": { "granted": true, "enabled": true }, "geoLocation": { "granted": false, "enabled": false }, "rota": { "granted": true, "enabled": true }, "noticeBoard": { "granted": true, "enabled": true }, "positiveBehaviour": { "granted": false, "enabled": false } }, "createdOn": "2026-07-20T08:56:42.725Z" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "IncidentReportResponseDto": { "type": "object", "properties": { "data": { "description": "Array of incident reports with enriched data from open_api schema", "example": [ { "id": "6980aa75a5429846498a40da", "createdOn": "2026-04-09T18:48:00.000Z", "log": { "title": "Safeguarding", "description": "Resident reported feeling unsafe in the garden area. Staff responded immediately and documented the incident.", "timeLogged": "2026-04-09T18:48:00.000Z", "location": "Garden" }, "case": null, "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987b2", "name": { "first": "David", "last": "Williams", "full": "David Williams" } }, "status": "needsReview", "closedBy": null, "closedOn": null, "severity": 2, "isDeleted": false, "reviewedOn": null, "closeComment": null, "category": { "id": "5e867702b349f776c8d48c34", "name": "Incident", "icon": "https://lmc-data-production.s3.eu-west-2.amazonaws.com/icons/qXxuGVYsSRgAcXoZ.png", "color": "#FF3366" }, "item": { "id": "68cae49a5df0b900121771f2", "name": "Safeguarding", "icon": "https://lmc-data-production.s3.eu-west-2.amazonaws.com/icons/DrpQZb2rGf1HHvuI.png" } } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "GoalResponseDto": { "type": "object", "properties": { "data": { "description": "Array of goals", "example": [ { "id": "6968bf21c441cf6fb4ac9a3e", "home": { "id": "home-123-abc", "name": "Sunrise Care Home" }, "resident": { "id": "resident_id_123", "name": { "first": "John", "last": "Doe", "full": "John Doe" } }, "createdBy": { "id": "user_id_789", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "editedBy": { "id": "user_id_790", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "logs": [ "6968bf21c441cf6fb4ac9a3f", "696f874462d69cb149439f25" ], "title": "Improve Mobility", "seenBy": [], "status": "notStarted", "actions": [], "endDate": "2026-06-30T00:00:00.000Z", "editedOn": "2026-01-23T14:18:42.514Z", "createdOn": "2026-01-15T10:30:00.000Z", "startDate": "2026-01-15T00:00:00.000Z", "importance": 8, "description": "Increase independent walking distance to 50 meters", "nextReviewDate": "2026-03-30T00:00:00.000Z", "progressHistory": [ { "date": "2026-01-15T10:19:13.900Z", "progress": 0 } ], "successMeasurement": "Able to walk 50 meters independently" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "RiskAssessmentResponseDto": { "type": "object", "properties": { "data": { "description": "Array of risk assessments", "example": [ { "id": "696f910b62d69cb14944bd29", "form": { "id": "6960cb5add702a0011af4ce2", "name": "", "formFields": [] }, "home": { "id": "home-123-abc", "name": "Sunrise Care Home" }, "resident": { "id": "resident_id_123", "name": { "first": "John", "last": "Doe", "full": "John Doe" }, "preferredName": "Johnny" }, "createdBy": { "id": "user_id_789", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "seenBy": [], "archived": false, "createdOn": "2026-01-20T14:28:27.400Z", "riskLevel": "high", "riskScore": 12, "incomplete": false, "reviewedOn": "2026-01-20T14:28:27.401Z" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "LogResponseDto": { "type": "object", "properties": { "data": { "description": "Array of logs (daily care notes) with enriched data", "example": [ { "id": "6980bf40b0d86defd672b8a1", "title": "Resident had a good breakfast", "type": "log", "timeLogged": "2026-02-02T15:14:02.272Z", "originalTimeLog": "2026-02-02T15:14:08.625Z", "description": "Ate all food, engaged in conversation with other residents. No assistance required.", "location": "Dining Room", "deleted": false, "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson", "full": "Margaret Thompson" } }, "loggedBy": { "id": "68406c31e55ca6b6d2262f56", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "editedBy": { "id": "68ef4775c1e051de495b175a", "name": { "first": "Sarah", "last": "Manager", "full": "Sarah Manager" } }, "category": { "id": "5e867702b349f776c8d48c34", "name": "Food & Drink" }, "item": { "id": "68cae49a5df0b900121771f2", "name": "Breakfast" }, "editedAt": "2026-02-02T15:20:00.000Z", "revisions": 0, "picture1": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/home/logs/example-home-id/photo1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260202%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260202T151402Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "picture2": null, "picture3": null, "videoFile": null, "videoThumbnail": null, "hidden": false, "isNextHandover": false, "revoked": false, "revokedAt": null, "nonEditable": false, "amount1": 250, "amount2": 0, "amountType": "ml", "stockQuantityType": "volume", "latitude": 51.5, "longitude": -1.5, "accuracy": 10, "itemSublevel": "Lunch", "doneBySu": false, "response": { "questions": [ { "key": "mood", "label": "Mood", "value": "Happy" } ] } } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "LogCategoryResponseDto": { "type": "object", "properties": { "data": { "description": "Array of log categories", "example": [ { "id": "5f213e77cdd809d04ba664be", "name": "Body Maps", "color": "#9966FB" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "LogCategoryItemResponseDto": { "type": "object", "properties": { "data": { "description": "Array of log category items", "example": [ { "id": "5e81db67b1b4e673bc2bb8cc", "name": "Catheter", "category": "5e867702b349f776c8d48c2f" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "DocumentResponseDto": { "type": "object", "properties": { "data": { "description": "Array of documents with enriched data", "example": [ { "id": "6977686fc18f55207654e609", "name": "Medical Assessment - January 2026", "createdAt": "2026-01-26T13:13:19.529Z", "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "resident": { "id": "69613fc010eecc5386f987ae", "name": { "first": "Margaret", "last": "Thompson", "full": "Margaret Thompson" } }, "category": { "id": "5f155c4ac49007031a671d4f", "name": "Care Plans" }, "pdf": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/docs/home/documents/example-home-id/document-file.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260126%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260126T131319Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "originalFile": "Medical_Assessment_Jan2026.pdf", "attachedToCarePlan": true } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "HomeDocumentResponseDto": { "type": "object", "properties": { "data": { "description": "Array of home documents with enriched data", "example": [ { "id": "6915ffc2e924f18fb5af8879", "name": "Fire Safety Policy - 2026", "createdAt": "2026-11-13T15:56:50.600Z", "home": { "id": "66e2aeef14dce156439010d5", "name": "Sunrise Care Home" }, "category": { "id": "5f155c4ac49007031a671d4f", "name": "General" }, "pdf": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/docs/home/homeDocuments/example-home-id/document-file.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260113%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260113T155650Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature", "originalFile": "Fire_Safety_Policy_2026.pdf" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] }, "DeviceResponseDto": { "type": "object", "properties": { "data": { "description": "Array of devices", "example": [ { "id": "64f8a1b23d4e5f6a7b8c9d0e", "name": "Reception Tablet", "uuid": "550e8400-e29b-41d4-a716-446655440000", "version": "4.2.1", "model": "iPad Pro 12.9", "type": "tablet", "users": [ { "id": "64f8a1b23d4e5f6a7b8c9d01", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } } ], "homes": [ { "home": { "id": "64f8a1b23d4e5f6a7b8c9d02", "name": "Sunrise Care Home" }, "status": "approved" } ], "lastUsedBy": { "id": "64f8a1b23d4e5f6a7b8c9d01", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "lastUsedOn": "2026-03-07T14:30:00.000Z", "createdBy": { "id": "64f8a1b23d4e5f6a7b8c9d03", "name": { "first": "Admin", "last": "User", "full": "Admin User" } }, "createdOn": "2026-01-15T10:00:00.000Z", "editedBy": { "id": "64f8a1b23d4e5f6a7b8c9d01", "name": { "first": "Jane", "last": "Smith", "full": "Jane Smith" } }, "editedOn": "2026-03-07T14:30:00.000Z" } ], "type": "array", "items": { "type": "object" } }, "pagination": { "description": "Pagination metadata", "allOf": [ { "$ref": "#/components/schemas/PaginationMetaDto" } ] } }, "required": [ "data", "pagination" ] } } }, "security": [ { "Bearer": [] } ] }