{"openapi":"3.0.3","info":{"title":"IM1 PFS Auth API","description":"## Overview\n\nIM1 PFS Auth provides a means of authenticating a user and establishing an IM1 session to access Patient-Facing Services (PFS).\nThe API authenticates a user via an NHS login token and routes requests to the specified supplier system and ODS code.\nIf the user's account is successfully matched, the API returns the new IM1 session details.\n\n![IM1 PFS Auth API High-level Diagram](https://raw.githubusercontent.com/NHSDigital/im1-pfs-auth/main/specification/assets/overview.drawio.svg)\n\nYou can use this API to:\n\n- authenticate a user and initiate a session with the appropriate supplier system for:\n  - a specific patient\n  - all patients that the logged-in user has an online account for\n\n## Who can use this API\nYou can only use this API if you have a valid legal basis.\nBefore investing significant time in development, confirm that your use case is appropriate by [contacting us](https://digital.nhs.uk/developer/help-and-support).\n\nYou must do this before you can go live.\n\n## API status and roadmap\nThis API is [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\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\n\nThis API supports [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis) access type with the following access modes:\n\n| Access mode                   | Access type            |\n|-------------------------------|------------------------|\n| Patient access                | User-restricted        |\n\nFor more information on access modes and how to use them, see the developer [security and authorisation guide](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation).\n\n### User-restricted access\n\nThis API has user-restricted access, meaning an end user must be present, authenticated and authorised.\n\n#### Patient access mode\nIf the end user is a patient then you must use this access mode.\n\n[Review all patient access modes](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#patient-access-mode)\n\n\n## Headers\nThis API is case-insensitive when processing request headers, meaning it will accept headers regardless of the letter casing used. For example, NHSE-Request-Id, nhse-request-id are treated the same.\n\n## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n\n* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action\n* 400 to 499 if it failed because of a client error by your application\n* 500 to 599 if it failed because of an error on our server\n\nEach endpoint lists its own specific errors in the Responses section. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n\n## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n\n| Resource         | Description                                               | Links                                                     |\n| ---------------- | --------------------------------------------------------- | --------------------------------------------------------- |\n| IM1 PFS Auth API | Source code for the API proxy, sandbox and specification. | [GitHub repo](https://github.com/NHSDigital/im1-pfs-auth) |\n\n## Environments and testing\n| Environment       | Base URL                                           |\n| ----------------- | -------------------------------------------------- |\n| Sandbox           | `https://sandbox.api.service.nhs.uk/im1-pfs-auth/` |\n| Integration test  | `https://int.api.service.nhs.uk/im1-pfs-auth/`     |\n\n### Sandbox testing\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing)\n\n* is for early developer testing\n* only covers a limited set of scenarios\n* is open access, so does not allow you to test authorisation\n\n[![Import Postman Collection](https://img.shields.io/badge/Import-Postman%20Collection-orange?logo=postman)](https://raw.githubusercontent.com/NHSDigital/im1-pfs-auth/main/postman/postman_collection.json)\n\nImport the  postman collection to run requests against sandbox.\n\n## Contact us\nFor help and support connecting to our APIs and to join our developer community, see [Help and support building healthcare software](https://digital.nhs.uk/developer/help-and-support).\n","termsOfService":null,"contact":null,"license":null,"version":"0.1"},"servers":[{"url":"https://sandbox.api.service.nhs.uk/im1-pfs-auth/","description":null,"variables":null},{"url":"https://int.api.service.nhs.uk/im1-pfs-auth/","description":null,"variables":null},{"url":"https://internal-dev.api.service.nhs.uk/im1-pfs-auth","description":null,"variables":null}],"paths":{"/authenticate":{"$ref":null,"summary":null,"description":null,"get":null,"put":null,"post":{"tags":["sessions"],"summary":"Create a session","description":"## Overview\n\nA user can authenticate and establish a session with GPIT supplier systems.\n\nThis endpoint:\n  - Verifies the user access token\n  - Determines which supplier system to forward requests onto\n  - Transforms response\n\n## Access modes\n\nThis endpoint supports the following access modes:\n- Patient access\n\n## Sandbox test scenarios\n\nSee the postman collection for example requests.\n\n| Scenario               | Request                                                                                     | Response                                                    |\n| ---------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |\n| Successful request     | Valid request with forward to value of https://example.com and ods code value of A29929     | HTTP Status 201 Success response                            |\n\n### Sandbox constraints\n  - Headers that are not required for the scenario are not validated and are disregarded.\n\nOr perhaps you'd like to try out the sandbox using our 'Try it out' feature.\n","externalDocs":null,"operationId":null,"parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"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":"^Bearer\\ [[:ascii:]]+$","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","deprecated":null},"example":null,"examples":null,"content":null,"name":"Authorization","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"The identifier of the calling application e.g. EMIS:  X-API-ApplicationId, and TPP: providerId.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"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},"example":null,"examples":null,"content":null,"name":"NHSE-Application-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"An ID which you can use to track transactions across multiple systems. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{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":null,"format":"uuid","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"NHSE-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"The GPIT Supplier base URL to forward requests to.\n\nTPP:\n| Environment | Allowed URLs                    |\n|-------------|---------------------------------|\n| Integration | https://systmonline2.tpp-uk.com |\n| Production  | https://systmonline.tpp-uk.com  |\n\nEMIS:\n| Environment | Allowed URLs                        |\n|-------------|-------------------------------------|\n| Integration | https://nhs70apptest.emishealth.com |\n| Production  | https://api.pfs.emis-x.uk           |\n","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"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},"example":null,"examples":null,"content":null,"name":"NHSE-Forward-To","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"The ODS code of the GP practice to start a session with.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"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":"A29929","deprecated":null},"example":null,"examples":null,"content":null,"name":"NHSE-ODS-Code","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"An optional ID which you can use to track transactions across multiple systems. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{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":null,"format":"uuid","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"NHSE-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false}],"requestBody":null,"responses":{"201":{"description":"The session was created successfully","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"},"example":null,"examples":null,"encoding":null}},"links":null},"4XX":{"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code              | Description                                                                                                                               |\n| ----------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 400         | `BAD_REQUEST`           | Missing header.                                                                                                                           |\n| 400         | `BAD_REQUEST`           | Invalid header.                                                                                                                           |\n| 401         | `UNAUTHORIZED`          | Missing or invalid OAuth 2.0 bearer token in request.                                                                                     |\n| 404         | `NOT_FOUND`             | Resource not found.                                                                                                                       |\n| 403         | `FORBIDDEN`             | Access denied to resource.                                                                                                                |\n| 408         | `REQUEST_TIMEOUT`       | Request timed out.                                                                                                                        |\n| 429         | `TOO_MANY_REQUESTS`     | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"missingValueError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/MissingValueError"},"invalidValueError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/InvalidValueError"},"notFoundError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/NotFoundError"},"accessDeniedError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/AccessDeniedErrorError"},"forbiddenError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/ForbiddenError"},"timeoutError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/TimeoutError"},"throttledError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/ThrottledError"}},"encoding":null}},"links":null},"5XX":{"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code              | Description                                       |\n| ----------- | ----------------------- | ------------------------------------------------- |\n| 500         | `SERVER_ERROR`          | An unexpected internal server error has occurred. |\n| 502         | `BAD_GATEWAY`           | An error downstream has occurred.                 |\n","headers":null,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"serverError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/InternalServerError"},"downstreamError":{"summary":null,"description":null,"value":null,"externalValue":"./examples/errors.yaml#/DownstreamError"}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":[{"nhs-login-p9":[]}],"servers":null},"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null}},"components":{"schemas":{"ResponseModel":{"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":[{"$ref":"#/components/schemas/EMISResponseModel"},{"$ref":"#/components/schemas/TPPResponseModel"}],"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},"EMISResponseModel":{"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":["sessionId","endUserSessionId","supplier","odsCode","user","patients"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"sessionId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":1,"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},"endUserSessionId":{"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},"supplier":{"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":["EMIS"],"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":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},"user":{"$ref":"#/components/schemas/EMISPersonModel"},"patients":{"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":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/EMISPersonModel"},"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":false,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"TPPResponseModel":{"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":["sessionId","supplier","odsCode","onlineUserId","user","patients"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"sessionId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":1,"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},"supplier":{"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":["TPP"],"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":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},"onlineUserId":{"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},"user":{"$ref":"#/components/schemas/TPPPersonModel"},"patients":{"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":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/TPPPersonModel"},"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":false,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"DemographicsModel":{"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":["firstName","surname","title","dateOfBirth"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"firstName":{"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},"surname":{"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":{"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},"dateOfBirth":{"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}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"PatientIdentifierModel":{"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":["value","type"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"value":{"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},"type":{"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}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"EMISPersonModel":{"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/DemographicsModel"},{"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":["userPatientLinkToken","patientIdentifiers","permissions"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"userPatientLinkToken":{"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},"patientIdentifiers":{"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":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/PatientIdentifierModel"},"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},"permissions":{"$ref":"#/components/schemas/EMISPermissionsModel"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":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},"EMISPermissionsModel":{"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":["appointmentsEnabled","demographicsUpdateEnabled","epsEnabled","medicalRecordEnabled","onlineTriageEnabled","practicePatientCommunicationEnabled","prescribingEnabled","recordSharingEnabled","recordViewAuditEnabled","medicalRecord"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"appointmentsEnabled":{"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":"boolean","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},"demographicsUpdateEnabled":{"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":"boolean","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},"epsEnabled":{"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":"boolean","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},"medicalRecordEnabled":{"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":"boolean","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},"onlineTriageEnabled":{"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":"boolean","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},"practicePatientCommunicationEnabled":{"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":"boolean","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},"prescribingEnabled":{"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":"boolean","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},"recordSharingEnabled":{"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":"boolean","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},"recordViewAuditEnabled":{"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":"boolean","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},"medicalRecord":{"$ref":"#/components/schemas/EMISMedicalRecordModel"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"EMISMedicalRecordModel":{"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":["recordAccessScheme","allergiesEnabled","consultationsEnabled","immunisationsEnabled","documentsEnabled","medicationEnabled","problemsEnabled","testResultsEnabled"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"recordAccessScheme":{"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":["Legacy","None","CoreSummaryCareRecord","DetailedCodedCareRecord"],"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},"allergiesEnabled":{"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":"boolean","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},"consultationsEnabled":{"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":"boolean","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},"immunisationsEnabled":{"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":"boolean","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},"documentsEnabled":{"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":"boolean","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},"medicationEnabled":{"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":"boolean","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},"problemsEnabled":{"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":"boolean","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},"testResultsEnabled":{"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":"boolean","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},"TPPPersonModel":{"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/DemographicsModel"},{"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":["patientId","patientIdentifiers","permissions"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"patientId":{"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":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"patientIdentifiers":{"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":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/PatientIdentifierModel"},"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},"permissions":{"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":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"$ref":"#/components/schemas/TPPPermissionsModel"},"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}],"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},"TPPPermissionsModel":{"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":["description","serviceIdentifier","status","statusDescription"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"description":{"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":["Full Clinical Record","Appointments","Request Medication","Questionnaires","Summary Record","Detailed Coded Record","Messaging","View Sharing Status","Record Audit","Change Pharmacy","Manage Sharing Rules And Requests","Access SystmConnect"],"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},"serviceIdentifier":{"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},"status":{"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":["A","U","N","G","O"],"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},"statusDescription":{"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":["Available","Unavailable","Not offered by unit","Only available to GMS registered patients","Other"],"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},"OperationOutcome":{"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":{"resourceType":{"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":"FHIR Resource Type.","format":null,"default":"OperationOutcome","nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"issue":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":1,"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":["severity","code"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"severity":{"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":["fatal","error","warning","information"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Severity of the error.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"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":["forbidden","processing","exception"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"FHIR error code.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"details":{"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":{"coding":{"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":"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":{"system":{"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":["https://fhir.nhs.uk/R4/CodeSystem/IM1-PFS-Auth-ErrorOrWarningCode"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"URI of the coding system specification.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"version":{"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":"Version of the coding system in use.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"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":"Symbol in syntax defined by the system.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"display":{"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":"Representation defined by the system.","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},"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":"Internal error code.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"diagnostics":{"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":"Additional diagnostic information about the issue. This information is subject to change.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"expression":{"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":"FHIRPath of element(s) related to the error.","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},"properties":null,"additionalProperties":null,"description":"List of issues that have occurred.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":"Outcome of an operation as a result of an error.\nThere are a number of possible error codes that can be returned along with a more detailed description in the `display` field.\n","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":{"nhs-login-p9":{"$ref":"https://proxygen.prod.api.platform.nhs.uk/components/securitySchemes/nhs-login-p9"}},"links":null,"callbacks":null},"security":null,"tags":null,"externalDocs":null,"x-nhsd-apim":null,"x-spec-publication":null}