{"openapi":"3.0.3","info":{"title":"Directory of Services - Ingest API","description":"## Overview\n\nUse this API to submit health and social care service data from your system to the NHS Directory of Services (DoS).\n\nThis API enables data partners to send structured updates on health and social care services: such as service availability, contact details, or referral information; which are validated and prepared for inclusion in the Directory of Services.\n\nDepending on your access mode, you may create or update:\n\n- health and social care service data\n- organisation data\n- location data\n\nThe API is designed for secure, system-to-system communication and supports consistent, efficient data submission; helping ensure the DoS remains accurate and up-to-date for use across NHS systems.\n\n## Who can use this API\n\nThis API is intended for approved data providers who need to submit or update service information in the NHS Directory of Services (DoS). Typical users may include NHS organisations, local authorities, or trusted third-party systems that manage health and social care service data.\n\nTo use this API, both your organization and the data source must be formally approved through our assurance process. This ensures that only high-quality, trusted data is submitted into the Directory of Services.\n\n[See Onboarding](#overview--onboarding).\n\n## Access modes\n\nThis API has two access modes. They are:\n * [application restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis) - addition of new resource allowed / replacement of organization allowed\n * [user restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis) - via a UI where healthcare workers authenticate\n\n## Roadmap\n\nThis API is in an [internal private beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses), meaning the API is not currently available for integration by external third parties. If you want to use this API when it becomes available for external use, please [Contact Us](https://digital.nhs.uk/developer/help-and-support) to register your interest.\n\n## Service Level\n\nBusiness hours support between 8am and 6pm, Monday to Friday, but not bank holidays.\n\nFor more details, see [Service Levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\n\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\n\nIt conforms to the FHIR UK Core STU3 v0.0.6, based on FHIR R4 v4.0.1.\n\nYou do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules. In particular:\n* resource names are capitalised and singular, for example /Patient not /patients\n* data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an extension object\n\nThere are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.\n\n## Network access\n\nThis API is available on the Internet.\n\n## Errors\n\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\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\nErrors specific to each API are shown in the Endpoints section, under Response. 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\n\nYou might find the following open source resources useful:\n| Resource | Description | Link |\n|-----|-----|-----|\n|Directory of Services - Ingest API | Source code for the API proxy, sandbox and specification | [Github](https://github.com/NHSDigital/ftrs-directory-of-services/tree/main/services/dos-ingest-api) |\n| FHIR libraries and SDKs | Various open source libraries for integrating with FHIR APIs | [FHIR libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) |\n\n## Environments and testing\n\nLinks to available environments:\n\n| Environment | Base URL |\n|-------------|----------|\n| Sandbox | https://sandbox.api.service.nhs.uk/dos-ingest/FHIR/R4 |\n| Integration | https://int.api.service.nhs.uk/dos-ingest/FHIR/R4 |\n\n### Sandbox\n\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):\n* is for early developer testing\n* only covers a limited set of scenarios\n* is stateless, so does not actually persist any updates\n* is open access, so does not allow you to test authorisation\n\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\n\n### Integration\n\nOur [integration environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):\n* is for formal integration testing\n* is stateful, so can persist updates\n* includes authorisation via JWT token\n\n## Onboarding\n\nThis API is not yet available for onboarding as it's in an [internal private beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses). You need to get your software approved by us before it can go live with this API, with further information to be added in due course.\n\n## Resources\n\nThe following resources are available to assist you with onboarding:\n* [API Documentation](https://digital.nhs.uk/developer/guides-and-documentation) - comprehensive guides and documentation for using our APIs\n* [Developer Forum](https://developer.community.nhs.uk/c/apim-platform/) - a community forum for developers to ask questions and share knowledge\n* [Support](https://digital.nhs.uk/developer/help-and-support) - contact our support team for assistance\n\n## Related APIs\n\nThe following APIs are related to this one:\n* [Directory of Services - Urgent and Emergency Care - REST API](https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest) - access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care\n* [Directory of Services - Urgent and Emergency Care - SOAP API](https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-soap) - use this API to access information on a wide range of health and care services across England\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":"1.0.0"},"servers":[{"url":"https://sandbox.api.service.nhs.uk/dos-ingest/FHIR/R4","description":"Sandbox","variables":null},{"url":"https://internal-dev-sandbox.api.service.nhs.uk/dos-ingest/FHIR/R4","description":"Internal Sandbox","variables":null},{"url":"https://internal-dev.api.service.nhs.uk/dos-ingest/FHIR/R4","description":"Development","variables":null},{"url":"https://internal-qa.api.service.nhs.uk/dos-ingest/FHIR/R4","description":"Internal QA","variables":null},{"url":"https://int.api.service.nhs.uk/dos-ingest/FHIR/R4","description":"Integration","variables":null},{"url":"https://ref.api.service.nhs.uk/dos-ingest/FHIR/R4","description":"Reference","variables":null},{"url":"https://api.service.nhs.uk/dos-ingest/FHIR/R4","description":"Production","variables":null}],"paths":{"/Organization":{"$ref":null,"summary":null,"description":null,"get":{"tags":null,"summary":"Search for organisations by ODS code to return organization details","description":"## Overview\nRetrieve an organization identified by an ODS code.\n\n## Request requirements\n- The `identifier` query parameter must be in the format `https://fhir.nhs.uk/Id/ods-organization-code|{CODE}` (minimum 1, maximum 12 alphanumeric characters).\n\nThe search is performed using the FHIR-compliant identifier parameter:\n- identifier={system}|{CODE}\n\nExample: /Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|ABC123\n\n## Sandbox testing\nUse the sandbox environment to test this endpoint without affecting real data.\n\n| ODS Code | Response |\n|----------|----------|\n| `ABC123` | `200` Returns a Bundle containing a matching Organization |\n| `GHI789` | `500` Internal Server Error |\n| Any other valid code | `404` Organization not found |\n\nValidation errors (400) are returned for:\n- Missing `identifier` query parameter entirely\n- Missing `|` separator in the identifier\n- Invalid identifier system (not `https://fhir.nhs.uk/Id/ods-organization-code`)\n- Invalid ODS code format (must be 1-12 alphanumeric characters)\n","externalDocs":null,"operationId":"searchOrganizations","parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n\nRequired in all environments except sandbox.\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":"^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":"Use an optional ID to track transactions across multiple systems.\nMirrored back in a response header.\n","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique request identifier in GUID format. A unique ID is generated for every\nincoming API request if not provided.\n","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":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":"7b2f8d3a-9e5c-4f1b-8a6d-2c4e9f1a3b5d","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"ODS code in the format \"{system}|{CODE}\" (FHIR identifier search).","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":"^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)\\|[A-Za-z0-9]{1,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":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"https://fhir.nhs.uk/Id/ods-organization-code|ABC123","deprecated":null},"example":null,"examples":null,"content":null,"name":"identifier","in":"query","allowEmptyValue":false,"allowReserved":false},{"$ref":"#/components/parameters/AcceptFHIR"}],"requestBody":null,"responses":{"200":{"description":"Bundle of Organizations found and returned successfully","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"example":{"resourceType":"Bundle","id":"87c5f637-cca3-4ddd-97a9-a3f6e6746bbe","type":"searchset","total":1,"link":[{"relation":"self","url":"https://api.service.nhs.uk/dos-ingest/FHIR/R4/Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|ABC123"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/dos-ingest/FHIR/R4/Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96","resource":{"resourceType":"Organization","id":"04393ec4-198f-42dd-9507-f4fa5e9ebf96","meta":{"profile":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"]},"identifier":[{"use":"official","system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"ABC123"}],"active":true,"name":"Example GP Practice","telecom":[{"system":"phone","value":"01234 567890"},{"system":"email","value":"example@example.com"}]},"search":{"mode":"match"}}]},"examples":null,"encoding":null}},"links":null},"400":{"description":"Bad request (e.g., invalid format of parameters)","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"missing-identifier":{"summary":"Missing required identifier parameter","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode","version":"1.0.0","code":"INVALID_SEARCH_DATA","display":"Invalid search data"}]},"diagnostics":"Invalid request data provided: Missing required request parameters: [identifier]"}]},"externalValue":null},"invalid-identifier-separator":{"summary":"Missing identifier separator","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"structure","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"BAD_REQUEST","display":"The Server was unable to process the request."}],"text":"Invalid identifier value: missing separator '|'. Must be in format 'https://fhir.nhs.uk/Id/ods-organization-code|' and code must follow format ^[A-Za-z0-9]{1,12}$"},"diagnostics":"Invalid identifier value: missing separator '|'. Must be in format 'https://fhir.nhs.uk/Id/ods-organization-code|' and code must follow format ^[A-Za-z0-9]{1,12}$"}]},"externalValue":null},"invalid-identifier-system":{"summary":"Invalid identifier system","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"structure","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"BAD_REQUEST","display":"The Server was unable to process the request."}],"text":"Invalid identifier system '' - expected 'https://fhir.nhs.uk/Id/ods-organization-code'"},"diagnostics":"Invalid identifier system '' - expected 'https://fhir.nhs.uk/Id/ods-organization-code'"}]},"externalValue":null},"invalid-identifier-format":{"summary":"Invalid ODS code format","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"structure","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"BAD_REQUEST","display":"The Server was unable to process the request."}],"text":"Invalid identifier value: ODS code '' must follow format ^[A-Za-z0-9]{1,12}$"},"diagnostics":"Invalid identifier value: ODS code '' must follow format ^[A-Za-z0-9]{1,12}$"}]},"externalValue":null},"unexpected-query-param":{"summary":"Unexpected query parameter","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"structure","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"BAD_REQUEST","display":"Parameter not understood"}],"text":"Unexpected query parameters provided"},"diagnostics":"Unexpected query parameter(s): foo, bar. Only 'identifier' is allowed."}]},"externalValue":null}},"encoding":null}},"links":null},"404":{"description":"Organization not found","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"not-found","details":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/operation-outcome","code":"MSG_NO_EXIST","display":"Resource does not exist"}],"text":"The requested organisation was not found"},"diagnostics":"Organisation with ODS code 'DEF456' not found"}]},"examples":null,"encoding":null}},"links":null},"401":{"description":"Unauthorized - Invalid or missing authentication token","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"security","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"UNAUTHORIZED","display":"Unauthorized"}]},"diagnostics":"Invalid or missing authentication token"}]},"examples":null,"encoding":null}},"links":null},"403":{"description":"Forbidden - Insufficient permissions","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"forbidden","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"FORBIDDEN","display":"Forbidden"}]},"diagnostics":"Insufficient permissions to access this resource"}]},"examples":null,"encoding":null}},"links":null},"422":{"description":"Unprocessable Entity (e.g., ODS code validation failed)","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"Validation failed for resource"},"diagnostics":"Validation failed for resource."}]},"examples":null,"encoding":null}},"links":null},"429":{"description":"Too many requests - Rate limit exceeded","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"throttled","details":{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode","version":"1.0.0","code":"SEND_TOO_MANY_REQUESTS","display":"Send too many requests"}]},"diagnostics":"Rate limit exceeded. Please retry after some time."}]},"examples":null,"encoding":null}},"links":null},"500":{"description":"Internal server error","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"fatal","code":"exception","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"SERVER_ERROR","display":"The Server has encountered an error processing the request."}],"text":"Unhandled exception occurred"},"diagnostics":"Unhandled exception occurred"}]},"examples":null,"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":[{"app-level3":[]}],"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null},"/Organization/{id}":{"$ref":null,"summary":null,"description":null,"get":null,"put":{"tags":null,"summary":"Update/overwrite an organization resource","description":"Update or overwrite an existing organization resource by ID.\n\n## Optional Extensions\n\nThe Organization resource supports the following optional FHIR extensions:\n\n### OrganisationRole Extension with Primary and Non-Primary Roles\n\nOrganizations can have multiple roles defined using OrganisationRole extensions. Each organization must have exactly one primary role and may optionally have multiple non-primary roles.\n\n- **OrganisationRole Extension URL**: `https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole`\n- **Required sub-extensions**:\n - `roleCode`: Sub-extension with `valueCodeableConcept` containing the organization role code from the ODS CodeSystem\n- **Optional sub-extensions**:\n - `instanceID`: Unique identifier for the role instance\n - `active`: Boolean indicating if the role is active\n - **TypedPeriod Extension** (`https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod`):\n - `dateType`: Must be set to \"Legal\" from the England-PeriodType CodeSystem\n - `period`: Contains `start` and/or `end` dates in YYYY-MM-DD format\n\n**Allowed Role Combinations**:\n- Organizations must be GP Practices with exactly one primary role (RO177 - Prescribing Cost Centre)\n- Must have RO76 (GP Practice) as one of the non-primary roles\n- May have additional non-primary roles alongside RO76\n- Duplicate non-primary role codes are not allowed\n- The primary role includes TypedPeriod extension with legal dates\n- Non-primary roles may optionally include TypedPeriod extensions\n\n**General Validation Rules**:\n- OrganisationRole extension must contain `roleCode` sub-extensions\n- OrganisationRole extension must contain at least one TypedPeriod extension\n- If TypedPeriod is included, it must contain both `dateType` and `period` sub-extensions\n- The `dateType` must be \"Legal\" with correct system URL\n- **The `period` must contain a `start` date (required) and may optionally contain an `end` date**\n- **TypedPeriod extension must have a valid URL - missing or empty URLs will be rejected**\n- Dates must be in YYYY-MM-DD format\n- Start and end dates must not be equal if both are provided\n- Extension URLs must exactly match the expected NHS England structure definitions\n\n**Example with Primary Role (RO177) and Multiple Non-Primary Roles**:\n```json\n\"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole\",\n \"extension\": [\n {\n \"url\": \"roleCode\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole\",\n \"code\": \"RO177\",\n \"display\": \"PRESCRIBING COST CENTRE\"\n }\n ]\n }\n },\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod\",\n \"extension\": [\n {\n \"url\": \"dateType\",\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-PeriodType\",\n \"code\": \"Legal\",\n \"display\": \"Legal\"\n }\n },\n {\n \"url\": \"period\",\n \"valuePeriod\": {\n \"start\": \"2020-01-15\",\n \"end\": \"2025-12-31\"\n }\n }\n ]\n }\n ]\n },\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole\",\n \"extension\": [\n {\n \"url\": \"roleCode\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole\",\n \"code\": \"RO76\",\n \"display\": \"GP PRACTICE\"\n }\n ]\n }\n }\n ]\n },\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole\",\n \"extension\": [\n {\n \"url\": \"roleCode\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole\",\n \"code\": \"RO268\",\n \"display\": \"MEDICINE SUPPLIER\"\n }\n ]\n }\n }\n ]\n }\n]\n```\n\n## Sandbox testing\nUse the sandbox environment to test this endpoint without affecting real data.\n\n| Organization ID | Response |\n|-----------------|----------|\n| `04393ec4-198f-42dd-9507-f4fa5e9ebf96` | `200` Organization updated successfully |\n| `trigger-422-validation-error` | `422` Validation error (e.g., invalid resource data) |\n| Any other ID | `404` Organization not found |\n\nNote: The ID `04393ec4-198f-42dd-9507-f4fa5e9ebf96` matches the Organization returned by the GET endpoint using ODS code `ABC123`, allowing you to test a complete read-update workflow.\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).\n\nRequired in all environments except sandbox.\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":"^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":"Use an optional ID to track transactions across multiple systems.\nMirrored back in a response header.\n","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Unique request identifier in GUID format. A unique ID is generated for every\nincoming API request if not provided.\n","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":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":"7b2f8d3a-9e5c-4f1b-8a6d-2c4e9f1a3b5d","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"$ref":"#/components/parameters/AcceptFHIR"},{"$ref":"#/components/parameters/ContentTypeFHIR"},{"description":"The unique identifier of the Organization resource to update.","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":"00000000-0000-0000-0000-00000000000a","deprecated":null},"example":null,"examples":null,"content":null,"name":"id","in":"path","allowEmptyValue":false,"allowReserved":false}],"requestBody":{"description":null,"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Organization"},"example":null,"examples":null,"encoding":null}},"required":true},"responses":{"200":{"description":"Organization updated","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"information","code":"informational","details":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/operation-outcome","code":"MSG_UPDATED","display":"Existing resource updated"}],"text":"Organisation updated successfully"},"diagnostics":"Organisation updated successfully"}]},"examples":null,"encoding":null}},"links":null},"404":{"description":"Organization not found","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"not-found","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"NOT_FOUND","display":"The Server was unable to find the specified resource."}],"text":"The requested organisation was not found"},"diagnostics":"Organisation not found."}]},"examples":null,"encoding":null}},"links":null},"422":{"description":"Unprocessable Entity (validation errors)","headers":{"X-Correlation-ID":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.","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":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":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false},"X-Request-ID":{"description":"The X-Request-ID from the request header, either generated or supplied, mirrored back.","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":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":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","deprecated":null},"example":null,"examples":null,"content":null,"name":"","in":"header","allowEmptyValue":false,"allowReserved":false}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"missing-required-field":{"summary":"Missing required field","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"Required field is missing"},"diagnostics":"Field 'name' is required"}]},"externalValue":null},"invalid-organisation-role-extension-url":{"summary":"Invalid OrganisationRole extension URL","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"Extension URL is invalid"},"diagnostics":"Invalid extension URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole-INVALID"}]},"externalValue":null},"missing-organisation-role-extension-url":{"summary":"Missing OrganisationRole extension URL","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"Extension URL is missing"},"diagnostics":"Invalid extension URL: None"}]},"externalValue":null},"invalid-typed-period-extension-url":{"summary":"Invalid TypedPeriod extension URL within OrganisationRole","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"TypedPeriod extension URL is invalid"},"diagnostics":"Invalid extension URL: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-InvalidTypedPeriod"}]},"externalValue":null},"invalid-typed-period-missing-subextension":{"summary":"TypedPeriod extension missing required sub-extension","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"TypedPeriod extension is incomplete"},"diagnostics":"TypedPeriod extension must contain both 'dateType' and 'period' sub-extensions"}]},"externalValue":null},"invalid-typed-period-non-legal":{"summary":"TypedPeriod extension with non-Legal dateType","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"dateType must be Legal"},"diagnostics":"dateType must be 'Legal' from system 'https://fhir.nhs.uk/England/CodeSystem/England-PeriodType'"}]},"externalValue":null},"invalid-typed-period-system":{"summary":"TypedPeriod extension with invalid system","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"dateType system is invalid"},"diagnostics":"dateType system must be 'https://fhir.nhs.uk/England/CodeSystem/England-PeriodType'"}]},"externalValue":null},"invalid-typed-period-empty-period":{"summary":"TypedPeriod extension with empty period","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"Legal period start date is required"},"diagnostics":"Legal period start date is required when TypedPeriod extension is present"}]},"externalValue":null},"invalid-typed-period-missing-start-date":{"summary":"TypedPeriod extension with missing start date","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"Legal period start date is required"},"diagnostics":"Legal period start date is required when TypedPeriod extension is present"}]},"externalValue":null},"invalid-typed-period-equal-dates":{"summary":"TypedPeriod extension with equal start and end dates","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"Start and end dates must not be equal"},"diagnostics":"Legal period start and end dates must not be equal"}]},"externalValue":null},"missing-typed-period-extension":{"summary":"OrganisationRole extension without required TypedPeriod","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"TypedPeriod extension is required"},"diagnostics":"OrganisationRole extension must contain at least one TypedPeriod extension"}]},"externalValue":null},"empty-typed-period-extension-url":{"summary":"TypedPeriod extension with empty URL","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"TypedPeriod extension URL is empty"},"diagnostics":"OrganisationRole extension must contain at least one TypedPeriod extension"}]},"externalValue":null},"missing-typed-period-extension-url":{"summary":"TypedPeriod extension with missing URL field","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","code":"UNPROCESSABLE_ENTITY","display":"Message was not malformed but deemed unprocessable by the server."}],"text":"TypedPeriod extension URL is missing"},"diagnostics":"OrganisationRole extension must contain at least one TypedPeriod extension"}]},"externalValue":null},"ro177-missing-non-primary-roles":{"summary":"RO177 primary role without required non-primary roles","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"RO177 requires the following non-primary roles: RO76"}]},"externalValue":null},"invalid-primary-role-code":{"summary":"Invalid primary role code (e.g., RO182)","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Valid primary role code (RO177) must be provided"}]},"externalValue":null},"invalid-non-primary-role-code":{"summary":"Invalid non-primary role code (e.g., RO268)","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"RO177 requires the following non-primary roles: RO76"}]},"externalValue":null},"duplicate-non-primary-roles":{"summary":"Duplicate non-primary role codes","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Duplicate non-primary roles are not allowed"}]},"externalValue":null},"missing-primary-role-code":{"summary":"Primary role code not provided","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Valid primary role code (RO177) must be provided"}]},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":[{"app-level3":[]}],"servers":null},"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null}},"components":{"schemas":{"Organization":{"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":["id","resourceType","meta","active","name","identifier"],"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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Organization","deprecated":null},"id":{"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":"00000000-0000-0000-0000-00000000000a","deprecated":null},"meta":{"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":{"profile":{"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":"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},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"],"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},"extension":{"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":["url","extension"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"url":{"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/England/StructureDefinition/Extension-England-OrganisationRole"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Extension URL identifying the extension type","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole","deprecated":null},"extension":{"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":["url"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"url":{"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":["instanceID","roleCode","https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod","active"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Sub-extension identifier","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"valueInteger":{"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":"Used for instanceID sub-extension (optional)","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":12345,"deprecated":null},"valueCodeableConcept":{"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":["coding"],"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":["system","code"],"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":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":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole","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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"RO76","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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"GP PRACTICE","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":"Used for roleCode sub-extension (required when url is 'roleCode')","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"valueBoolean":{"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":"Used for active sub-extension (optional when url is 'active')","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":true,"deprecated":null},"extension":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":2,"minItems":2,"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":["url"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"url":{"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":["dateType","period"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"TypedPeriod sub-extension identifier","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"valueCoding":{"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":["system","code"],"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/England/CodeSystem/England-PeriodType"],"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":"https://fhir.nhs.uk/England/CodeSystem/England-PeriodType","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":["Legal"],"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":"Legal","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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Legal","deprecated":null}},"additionalProperties":null,"description":"Used for dateType sub-extension (required when url is 'dateType')","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"valuePeriod":{"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":["start"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"start":{"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":"Legal start date in YYYY-MM-DD format (required when TypedPeriod extension is present)","format":"date","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2020-01-15","deprecated":null},"end":{"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":"Legal end date in YYYY-MM-DD format (optional)","format":"date","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"2025-12-31","deprecated":null}},"additionalProperties":null,"description":"Used for period sub-extension containing start and/or end dates (required when url is 'period', start date is required)","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":"Nested sub-extensions for TypedPeriod containing dateType and period (both required if TypedPeriod extension is present)","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":"Sub-extensions for the OrganisationRole","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":"Optional FHIR extensions. Currently supports:\n- OrganisationRole extension containing TypedPeriod for legal start and end dates\n","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole","extension":[{"url":"instanceID","valueInteger":12345},{"url":"roleCode","valueCodeableConcept":{"coding":[{"system":"https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole","code":"RO76","display":"GP PRACTICE"}]}},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod","extension":[{"url":"dateType","valueCoding":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-PeriodType","code":"Legal","display":"Legal"}},{"url":"period","valuePeriod":{"start":"2020-01-15","end":"2025-12-31"}}]}]}],"deprecated":null},"active":{"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":true,"deprecated":null},"name":{"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":"GP Practice Name","deprecated":null},"identifier":{"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":["system","value"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"use":{"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":["official"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Identifies the purpose of this identifier (fixed to 'official' for ODS codes)","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"official","deprecated":null},"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/Id/ods-organization-code"],"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":"https://fhir.nhs.uk/Id/ods-organization-code","deprecated":null},"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":"ABC123","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},"telecom":{"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":["system","value"],"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":["phone","email"],"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":"phone","deprecated":null},"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":"01234 567890","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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"Bundle":{"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":["resourceType","type","entry"],"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":["Bundle"],"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":"Bundle","deprecated":null},"id":{"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":"87c5f637-cca3-4ddd-97a9-a3f6e6746bbe","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":["searchset"],"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":"searchset","deprecated":null},"total":{"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":"Total number of resources that match the search criteria","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":1,"deprecated":null},"link":{"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":{"relation":{"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":"self","deprecated":null},"url":{"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":"https://api.service.nhs.uk/dos-ingest/FHIR/R4/Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|ABC123","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":"Links related to this Bundle, including self-reference","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"entry":{"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":["resource"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"fullUrl":{"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":"Absolute URL for this resource","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"https://api.service.nhs.uk/dos-ingest/FHIR/R4/Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96","deprecated":null},"resource":{"$ref":"#/components/schemas/Organization"},"search":{"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":{"mode":{"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":["match","include"],"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":"match","deprecated":null}},"additionalProperties":null,"description":"Search metadata for this entry","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":"Organization resources matching the search criteria.","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":["resourceType","issue"],"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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"OperationOutcome","deprecated":null},"issue":{"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":["severity","code","details"],"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":"Indicates how relevant the issue is to the overall success of the action","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"error","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":"FHIR issue type code (e.g., invalid, not-found, exception)","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"invalid","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":["coding"],"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":["system","code","display"],"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/CodeSystem/http-error-codes"],"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":"https://fhir.nhs.uk/CodeSystem/http-error-codes","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":"Code from the FHIR operation-outcome CodeSystem","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"UNPROCESSABLE_ENTITY","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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Message was not malformed but deemed unprocessable by the server.","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},"text":{"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":"Human-readable description of the error","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"The ODS code format is invalid","deprecated":null}},"additionalProperties":null,"description":"Additional details about the error using FHIR operation-outcome codes","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":"Detailed diagnostic information","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"ODS code 'ABC!!!' must follow format ^[A-Za-z0-9]{1,12}$","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":"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":"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},"properties":null,"additionalProperties":null,"description":"FHIRPath expression indicating which element(s) caused the issue","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":["Organization.identifier[0].value"],"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":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"responses":null,"parameters":{"AcceptFHIR":{"description":"Must be set to `application/fhir+json` to receive FHIR-compliant responses.","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":["application/fhir+json"],"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":"application/fhir+json","deprecated":null},"example":null,"examples":null,"content":null,"name":"Accept","in":"header","allowEmptyValue":false,"allowReserved":false},"ContentTypeFHIR":{"description":"Must be set to `application/fhir+json` for FHIR resource requests.","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":["application/fhir+json"],"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":"application/fhir+json","deprecated":null},"example":null,"examples":null,"content":null,"name":"Content-Type","in":"header","allowEmptyValue":false,"allowReserved":false}},"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":null,"tags":null,"externalDocs":null,"x-nhsd-apim":null,"x-spec-publication":null}