{"openapi":"3.0.3","info":{"title":"Staff Index API","description":"## Overview\nA centralised staff index and provisioning system for NHS England. This service manages identity records and provisions accounts to external systems such as Local AD and NHS.net Connect.\n\nYou can:\n- Create new staff records\n- Search for existing staff records\n\n## Who can use this API\nDuring Private Beta, access is closed to a select few applications.\n\n## API status and roadmap\nThis API is [In development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\n\nIf you have any other queries, [contact us](https://digital.nhs.uk/developer/help-and-support).\n\n## Service level\nThis API is a bronze service during private beta, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays.\n(The planned production service level will be platinum.)\n\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Network access\nThis API is available on the internet.\n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Security and authorisation\nThis API is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate the calling application but not the end user.\n\nTo use this API, use the following security pattern:\n\n* [Application-restricted RESTful APIs - signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\n\n## Environments and testing\n| Environment       | Base URL                                     |\n| ----------------- | ---------------------------------------------|\n| Integration test  | `https://int.api.service.nhs.uk/staff-index` |\n| Production        | `https://api.service.nhs.uk/staff-index`     |\n\n### Sandbox testing\nWe currently do not have a [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing).\n\n### Integration testing\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):\n- is for formal integration testing\n- requires application authentication\n\nThis environment will persist records, however, the environment is periodically reset so records can be removed at any time.\n\nAnyone can register and create an access app for the integration environment following the onboarding instructions below. The API is listed as \"Staff Index - Application Restricted (Integration)\".\n\n## Onboarding\n\n1. Login to the developer platform and create an access app connected to the Staff Index API - https://onboarding.prod.api.platform.nhs.uk/\n2. Create and assign a Product ID to access app through [ServiceNow](https://www.support.internalservices.england.nhs.uk/nhs_digital?id=sc_cat_item&sys_id=6e048d0797d8cb94dd80f2df9153af0c)\n3. Follow these instructions for setting up signed JWT auth - https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication\n","termsOfService":null,"contact":null,"license":null,"version":"0.0.1"},"servers":[{"url":"/","description":null,"variables":null}],"paths":{"/Person/{personUniqueIdentifier}":{"$ref":null,"summary":null,"description":null,"get":{"tags":["Person"],"summary":"Retrieve Person record","description":"Retrieve related records of a Person by their unique identifier.","externalDocs":null,"operationId":"get_person_Person__personUniqueIdentifier__get","parameters":[{"description":null,"required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":"Personuniqueidentifier","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":null,"content":null,"name":"personUniqueIdentifier","in":"path","allowEmptyValue":false,"allowReserved":false}],"requestBody":null,"responses":{"422":{"description":"Unprocessable Entity/Validation Error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"200":{"description":"Person record retrieved successfully","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPersonResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"404":{"description":"Staff identity record not found","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"500":{"description":"Internal server error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"},"example":null,"examples":null,"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null},"/health":{"$ref":null,"summary":null,"description":null,"get":{"tags":["Health"],"summary":"Health Check","description":"The health check endpoint confirms the backend is reachable via the API and returns basic information about the service status.","externalDocs":null,"operationId":"get_health_health_get","parameters":null,"requestBody":null,"responses":{"422":{"description":"Unprocessable Entity/Validation Error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"200":{"description":"Health check response","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"500":{"description":"Internal server error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"},"example":null,"examples":null,"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null},"/Person":{"$ref":null,"summary":null,"description":null,"get":null,"put":null,"post":{"tags":["Person"],"summary":"Create a new Person record","description":"This is the root level record for a person in the Staff Index that represents personal information that does not vary between roles or organisations.\nA Person record may be linked to multiple ServicePerson records.","externalDocs":null,"operationId":"create_person_Person_post","parameters":null,"requestBody":{"description":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonRequest"},"example":null,"examples":null,"encoding":null}},"required":true},"responses":{"422":{"description":"Unprocessable Entity/Validation Error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"201":{"description":"Person record created successfully","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePersonResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"200":{"description":"Person record not created due to filter policy","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePersonFilteredResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"409":{"description":"Duplicate record or constraint violation","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"500":{"description":"Internal server error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"},"example":null,"examples":null,"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null},"/ServicePerson":{"$ref":null,"summary":null,"description":null,"get":{"tags":["Service Person"],"summary":"Retrieve ServicePerson record","description":"Retrieve a ServicePerson record by the person's unique identifier and the organisation's ODS code.\nThis will also return details of any provisioned accounts.","externalDocs":null,"operationId":"get_service_person_ServicePerson_get","parameters":[{"description":null,"required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":"Personuniqueidentifier","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":null,"content":null,"name":"personUniqueIdentifier","in":"query","allowEmptyValue":false,"allowReserved":false},{"description":null,"required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":"Odscode","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":null,"content":null,"name":"odsCode","in":"query","allowEmptyValue":false,"allowReserved":false}],"requestBody":null,"responses":{"422":{"description":"Unprocessable Entity/Validation Error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"200":{"description":"Service Person record retrieved successfully","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServicePersonResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"404":{"description":"Staff identity record not found","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"500":{"description":"Internal server error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"},"example":null,"examples":null,"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"put":null,"post":{"tags":["Service Person"],"summary":"Create a new ServicePerson record","description":"The ServicePerson record represents a person's relationship with an organisation and must be linked to a Person record.\nThis endpoint may also trigger provisioning events to external systems.","externalDocs":null,"operationId":"provision_service_person_ServicePerson_post","parameters":null,"requestBody":{"description":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePersonRequest"},"example":null,"examples":null,"encoding":null}},"required":true},"responses":{"422":{"description":"Unprocessable Entity/Validation Error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"201":{"description":"Service Person record created successfully","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServicePersonResponse"},"example":null,"examples":null,"encoding":null}},"links":null},"500":{"description":"Internal server error","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponse"},"example":null,"examples":null,"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":null,"servers":null},"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null}},"components":{"schemas":{"CimProfileType":{"title":"CimProfileType","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Standard","TAC","RPA"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Valid CIM profile type values.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"CimServicePersonRequest":{"title":"CimServicePersonRequest","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"uuid":{"title":"Uuid","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^.{1,100}$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"CIM UUID (up to 100 characters)","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"profileType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/CimProfileType"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"CIM profile type. Accepts canonical names (Standard, TAC, RPA) or legacy numbered values (1, 2, 3). Numbered values are mapped to their canonical equivalents.","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["Standard","TAC","RPA","1","2","3"]},"statusId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/CimStatus"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"CIM status (1 = Open, 2 = Closed)","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["1","2"]}},"additionalProperties":false,"description":"CIM ServicePerson data.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"CimServicePersonResponse":{"title":"CimServicePersonResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"uuid":{"title":"Uuid","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"profileType":{"title":"Profiletype","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"statusId":{"title":"Statusid","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"contact":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/ContactResponse"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"CimStatus":{"title":"CimStatus","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["1","2"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Valid CIM status values.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ConflictResponse":{"title":"ConflictResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["message"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":"Message","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ContactRequest":{"title":"ContactRequest","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"emailAddress":{"title":"Emailaddress","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Valid email address with @ symbol and TLD","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["john.doe@nhs.net","staff@example.com"]},"mobileNumber":{"title":"Mobilenumber","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^\\+?[1-9]\\d{1,14}$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Valid mobile phone number in E.164 format","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["+447911123456","07911123456"]}},"additionalProperties":false,"description":"Contact information for a person.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ContactResponse":{"title":"ContactResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"emailAddress":{"title":"Emailaddress","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"mobileNumber":{"title":"Mobilenumber","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"CreatePersonFilteredResponse":{"title":"CreatePersonFilteredResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":"Message","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":"Person record not created as its source was not AfCID","nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"CreatePersonResponse":{"title":"CreatePersonResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["person"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"person":{"$ref":"#/components/schemas/PersonResponse"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"CreateServicePersonResponse":{"title":"CreateServicePersonResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["servicePerson"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"servicePerson":{"$ref":"#/components/schemas/ServicePersonResponse"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"DigitalIdentityRequest":{"title":"DigitalIdentityRequest","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["identityAssuranceSource","eGifReg"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"identityAssuranceSource":{"$ref":"#/components/schemas/IdentityAssuranceSource","examples":["1","3","4"],"description":"Source of identity assurance (1 = CareID, 2 = ESR, 3 = CIM, 4 = SSR/AfCID)"},"eGifReg":{"$ref":"#/components/schemas/EGifReg","examples":[0,1,3],"description":"eGIF registration level (0, 1, or 3)"},"identityAssuranceLevel":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/IdentityAssuranceLevel"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Identity assurance level","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["IAL_1","GPG45_VERY_HIGH"]}},"additionalProperties":false,"description":"Digital identity information for a person.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"DigitalIdentityResponse":{"title":"DigitalIdentityResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["identityAssuranceSource","eGifReg"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"identityAssuranceSource":{"title":"Identityassurancesource","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"eGifReg":{"title":"Egifreg","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"identityAssuranceLevel":{"title":"Identityassurancelevel","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"EGifReg":{"title":"EGifReg","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":[0,1,3],"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Valid eGIF registration level values.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"GetPersonResponse":{"title":"GetPersonResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["person"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"person":{"$ref":"#/components/schemas/PersonResponse"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"GetServicePersonResponse":{"title":"GetServicePersonResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["servicePerson"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"servicePerson":{"$ref":"#/components/schemas/ServicePersonResponse"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"HTTPValidationError":{"title":"HTTPValidationError","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"detail":{"title":"Detail","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/ValidationError"},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"HealthResponse":{"title":"HealthResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["status","service","commit","timestamp"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"status":{"$ref":"#/components/schemas/HealthStatus"},"service":{"title":"Service","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"commit":{"title":"Commit","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"timestamp":{"title":"Timestamp","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"HealthStatus":{"title":"HealthStatus","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["pass","fail"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"IdentityAssuranceLevel":{"title":"IdentityAssuranceLevel","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["IAL_1","IAL_2","IAL_3","GPG45_LOW","GPG45_MEDIUM","GPG45_HIGH","GPG45_VERY_HIGH"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"IdentityAssuranceSource":{"title":"IdentityAssuranceSource","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["1","2","3","4"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Valid identity assurance source values.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"InternalServerErrorResponse":{"title":"InternalServerErrorResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["message"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":"Message","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"NotFoundResponse":{"title":"NotFoundResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["message"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":"Message","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"PersonRecordLifecycleRequest":{"title":"PersonRecordLifecycleRequest","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["creationOrganisationOdsCode","actualCreationDate"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"creationOrganisationOdsCode":{"title":"Creationorganisationodscode","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^[A-Za-z0-9]{3,10}$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"ODS code of the organisation that created the record","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["RKE","7A4BV"]},"creationOrganisationName":{"title":"Creationorganisationname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Name of the organisation that created the record","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["NHS Trust"]},"actualCreationDate":{"title":"Actualcreationdate","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Actual creation date in ISO 8601 format","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["2026-01-15T10:30:00"]}},"additionalProperties":false,"description":"Lifecycle metadata for the person record.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"PersonRecordLifecycleResponse":{"title":"PersonRecordLifecycleResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["creationOrganisationOdsCode","actualCreationDate"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"creationOrganisationOdsCode":{"title":"Creationorganisationodscode","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"creationOrganisationName":{"title":"Creationorganisationname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"actualCreationDate":{"title":"Actualcreationdate","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"PersonRequest":{"title":"PersonRequest","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["legalFirstName","legalSurname","dateOfBirth","digitalIdentity","personRecordLifecycle"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"title":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/Title"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Title/salutation for the person","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["Mr","Mrs","Dr"]},"legalFirstName":{"title":"Legalfirstname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":35,"minLength":null,"pattern":"^[A-Za-z' -]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Legal first name","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"legalMiddleName":{"title":"Legalmiddlename","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":35,"minLength":null,"pattern":"^[A-Za-z' -]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Legal middle name","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"legalSurname":{"title":"Legalsurname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":35,"minLength":2,"pattern":"^[A-Za-z' -]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Legal surname","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"preferredName":{"title":"Preferredname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":35,"minLength":null,"pattern":"^[A-Za-z' -]+$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Preferred first name (name on smartcard)","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"dateOfBirth":{"title":"Dateofbirth","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Date of birth in ISO 8601 format (YYYY-MM-DD)","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["1980-12-31","1995-06-15"]},"nationalInsuranceNumber":{"title":"Nationalinsurancenumber","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^[A-CEGHJ-PR-TW-Z][A-CEGHJ-NPR-TW-Z][0-9]{6}[A-D]$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"National Insurance Number in format: 2 letters, 6 digits, 1 letter (e.g., AB123456C)","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["AB123456C","JY987654D"]},"contact":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/ContactRequest"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"digitalIdentity":{"$ref":"#/components/schemas/DigitalIdentityRequest"},"personRecordLifecycle":{"$ref":"#/components/schemas/PersonRecordLifecycleRequest"},"cimServicePerson":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/CimServicePersonRequest"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":false,"description":"Request model for creating a new staff identity record with validation.\nThis follows the logical data model (see linked MSI Data attributes table for details of mandatory/optional fields)\nhttps://nhsd-confluence.digital.nhs.uk/spaces/MSI/pages/1177387364/Logical+Data+Model\nValidation logic is currently following the CIM API\nhttps://nhsd-confluence.digital.nhs.uk/spaces/CIS/pages/456434755/CIM+-+API+-+Create+User","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"PersonResponse":{"title":"PersonResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["personUniqueIdentifier","legalFirstName","legalSurname","dateOfBirth","digitalIdentity","personRecordLifecycle"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"personUniqueIdentifier":{"title":"Personuniqueidentifier","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"title":{"title":"Title","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"legalFirstName":{"title":"Legalfirstname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"legalMiddleName":{"title":"Legalmiddlename","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"legalSurname":{"title":"Legalsurname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"preferredName":{"title":"Preferredname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"dateOfBirth":{"title":"Dateofbirth","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"nationalInsuranceNumber":{"title":"Nationalinsurancenumber","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"cimServicePerson":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/CimServicePersonResponse"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"digitalIdentity":{"$ref":"#/components/schemas/DigitalIdentityResponse"},"personRecordLifecycle":{"$ref":"#/components/schemas/PersonRecordLifecycleResponse"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ServiceAccounts":{"title":"ServiceAccounts","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["serviceType","provisioningStatus"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"serviceType":{"title":"Servicetype","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"provisioningStatus":{"title":"Provisioningstatus","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ServicePersonRequest":{"title":"ServicePersonRequest","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["personUniqueIdentifier","odsCode","serviceLevelUserName","cimProfileType","isEnabled"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"personUniqueIdentifier":{"title":"Personuniqueidentifier","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Person Unique Identifier (PUID) assigned to the staff identity","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["U.AB-12-CD"]},"odsCode":{"title":"Odscode","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^[A-Za-z0-9]{3,10}$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"ODS (Organisation Data Service) code","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["RKE","7A4BV"]},"serviceLevelUserName":{"title":"Servicelevelusername","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^[0-9]{12}$","maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Service level user name (no spaces) (specific to CIM)","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["656036872984"]},"cimProfileType":{"$ref":"#/components/schemas/CimProfileType","examples":["Standard","TAC","RPA"],"description":"Variant type"},"displayName":{"title":"Displayname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"TBC","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"employeeNumber":{"title":"Employeenumber","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Employee number","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null,"examples":["123456"]},"jobTitle":{"title":"Jobtitle","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"TBC","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"professionalCategory":{"title":"Professionalcategory","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"TBC","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"employmentType":{"title":"Employmenttype","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"TBC","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"isEnabled":{"title":"Isenabled","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"boolean","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Indicates whether the account is active or closed","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":false,"description":"Request model for creating a new staff identity record with validation.\nThis follows the logical data model (see linked MSI Data attributes table for details of mandatory/optional fields)\nhttps://nhsd-confluence.digital.nhs.uk/spaces/MSI/pages/1177387364/Logical+Data+Model\nValidation logic is currently following the CIM API\nhttps://nhsd-confluence.digital.nhs.uk/spaces/CIS/pages/456434755/CIM+-+API+-+Create+User#:~:text=%2C%20None%2C%20%22%22-,givenName,-String","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ServicePersonResponse":{"title":"ServicePersonResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["personUniqueIdentifier","odsCode","jobTitle","serviceLevelUserName","cimProfileType","displayName","employeeNumber","professionalCategory","employmentType","serviceAccounts"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"personUniqueIdentifier":{"title":"Personuniqueidentifier","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"odsCode":{"title":"Odscode","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"jobTitle":{"title":"Jobtitle","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"serviceLevelUserName":{"title":"Servicelevelusername","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"cimProfileType":{"title":"Cimprofiletype","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"displayName":{"title":"Displayname","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"employeeNumber":{"title":"Employeenumber","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"professionalCategory":{"title":"Professionalcategory","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"employmentType":{"title":"Employmenttype","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"serviceAccounts":{"title":"Serviceaccounts","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/ServiceAccounts"},"properties":null,"additionalProperties":null,"description":"Unsorted list of service accounts associated with the service person.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"Title":{"title":"Title","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Mr","Mrs","Ms","Miss","Dr","Nurse","Sister","Brother","Sir","Canon","Dame","Father","Imam","Lady","Lord","Major","Rabbi","Right Reverend Monsigneur","Reverend","Professor","Baron","Baroness","Mx"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Valid title values for a person.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"UnprocessableEntityResponse":{"title":"UnprocessableEntityResponse","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["message"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"message":{"title":"Message","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"detail":{"title":"Detail","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":true,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ValidationError":{"title":"ValidationError","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["loc","msg","type"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"loc":{"title":"Location","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":[{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"integer","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}],"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"type":{"title":"Error Type","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ResponseValidationError":{"title":"ResponseValidationError","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"detail":{"title":"Detail","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/ValidationError"},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"responses":null,"parameters":null,"examples":null,"requestBodies":null,"headers":null,"securitySchemes":{"app-level3":{"$ref":"https://proxygen.prod.api.platform.nhs.uk/components/securitySchemes/app-level3"}},"links":null,"callbacks":null},"security":[{"app-level3":[]}],"tags":[{"name":"Health","description":null,"externalDocs":null},{"name":"Person","description":null,"externalDocs":null},{"name":"Service Person","description":null,"externalDocs":null}],"externalDocs":null,"x-nhsd-apim":null,"x-spec-publication":null}