{"openapi":"3.0.3","info":{"title":"Directory of Services Search API","description":"## Overview\nUse this API to access healthcare services details profiled in the Directory of Services. This API provides read-only access to the data held in the directory.\n\nYou can:\n- obtain Organisation details (including endpoints managed by the Organisation) for a given Organisation ODS Code\n\nIn the future you will be able to:\n- search for HealthcareService details for services associated with a given Organisation ODS Code (see note below — this endpoint is published but not yet available for use)\n- search for HealthcareService details using a triage code combination (see note below — this endpoint is published but not yet available for use)\n- obtain HealthcareService details (including endpoints managed by the service) for a given service identifier\n\n## Who can use this API\nThis API can only be used where you have a valid use case to do so. Please [contact us](https://digital.nhs.uk/developer/help-and-support) before you go too far with your development.\nYou must do this before you can go live (see 'Onboarding' below).\n\n## Access modes\nThis API supports the following access modes:\n- restricted access\n\n### Restricted access\nThis is the only access mode supported by the API and it is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application but not the end user. This mode is used as part of a back-end process to retrieve healthcare service details.\n\nThis access mode adopts the following security/authentication patterns:\n- JWT Private Key authentication\n\n## Roadmap\nOver 2026 and 2027, we will be making further endpoints available covering the functionality of:\n\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)\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)\n- [Electronic Prescription Service Directory of Services API](https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-directory-of-services)\n\n## Service level\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## Versioning and Deprecation\n\n### Versioning Strategy\n\n#### Version Numbering\n\n- The URL path will indicate any industry standard and FHIR version, e.g. `/dos-search/FHIR/R4` for the standard, which is separate from the API major versioning.\n- For selecting the logic version, use the `version` parameter in the accept header, e.g. `version: 2`\n  - The logic version is for *major* versions only. As we define this based on [SemVer](https://semver.org/), a minor version is non-breaking and therefore it does not need to be specified.\n\n#### Backward Compatibility\n\n- Minor, backward-compatible changes (e.g., adding new optional fields) may be made within an existing version without incrementing the version number.\n- Any breaking changes (e.g., removing or altering response fields, changing authentication methods, or altering endpoint behaviour) will result in a new version.\n\n#### Version Format\n\n- Versions will use a simple integer (e.g., `1`, `2`).\n\n\n### Deprecation Policy\n\n#### Deprecation Announcement\n\n- When an API version is scheduled for retirement, affected consumers will be notified at least *3 months* prior to retirement via a deprecation notice.\n\n#### Deprecation Timeline\n\n- Deprecated versions will remain available and fully supported for at least *3 months* from the deprecation notice, unless urgent security or compliance risks require earlier removal.\n\n#### Support During Deprecation\n\n- During the deprecation period, only critical bug fixes and security updates will be applied to deprecated versions.\n- Consumers are encouraged to migrate to the latest version as soon as possible.\n\n#### Retirement\n\n- After the deprecation period, the version will be permanently removed, and requests to those endpoints will fail with an appropriate error code.\n\n### Consumer Responsibilities\n\n- Consumers are responsible for tracking deprecation notices and planning upgrades accordingly.\n- Integration with the latest API version is strongly recommended to take advantage of new features and security updates.\n\n### Exceptions\n\nIn the event of a critical security issue or compliance requirement, the API team reserves the right to shorten the deprecation period and will notify consumers as early as possible.\n\n### Contact & Support\n\nFor questions or concerns regarding versioning, deprecation, or migration, please contact our API support team through our [*Customer Service Portal*](https://digital.nhs.uk/developer/help-and-support).\n\n\n## Rate limits\nThe default rate limit is 10TPS (Transactions Per Second), per app.\n\nIf you exceed this limit, you will receive a 429 'Too Many Requests' response. For more information, see [rate limits](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits)\n\n## Technology\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](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#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- array names are singular, for example entry not entries for Bundle entries\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\n## Network access\nThis API is available over the internet.\n\nThis API is accessible from the public internet using standard HTTPS connections. See access mode section for authentication methods.\n\nThis API does not support static IP hosting. The IP addresses that host this API are dynamic and subject to change without notice.\n\n## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n- 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\n- Errors specific to each API endpoint are shown in the Endpoints section under Response.\n- See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n- For 404 errors, see [404 resource not found](https://digital.nhs.uk/developer/guides-and-documentation/troubleshooting-4xx-status-codes#404-resource_not_found).\n- For 5xx errors, see [trouble shooting 5xx status codes](https://digital.nhs.uk/developer/guides-and-documentation/troubleshooting-5xx-status-codes).\n- Your API-calling application should automatically retry failed requests where appropriate (for example, by giving status information to your end user before giving up).\n- See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling) for more information about error handling.\n\n## Environments and testing\n\n### Sandbox testing\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing) is for early developer testing, only covers a limited set of scenarios, and is open access, so does not allow you to test authorisation.\nLink to sandbox test environment: `https://sandbox.api.service.nhs.uk/dos-search/FHIR/R4`\n\n### Integration testing\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing) is for formal integration testing and includes authorisation via JWT Private Key.\nLink to integration test environment: `https://int.api.service.nhs.uk/dos-search/FHIR/R4`\n\n## Onboarding\nYou need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it's worth planning well ahead.\n\nFor more information about the onboarding process, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n\n## Open source\nYou might find it useful to know that the [FHIR specification](https://www.hl7.org/fhir/) is open source and available on GitHub.\n\n## Related APIs\nThe following APIs are related to this API:\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)\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)\n- [Electronic Prescription Service - Directory of Services API](https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-directory-of-services)\n\n## Contact us\nFor support or to provide feedback on this API, please [contact us](https://digital.nhs.uk/developer/help-and-support).\n","version":"1.0.0"},"servers":[{"url":"https://sandbox.api.service.nhs.uk/dos-search/FHIR/R4","description":"Sandbox"},{"url":"https://int.api.service.nhs.uk/dos-search/FHIR/R4","description":"Integration"},{"url":"https://ref.api.service.nhs.uk/dos-search/FHIR/R4","description":"Reference"},{"url":"https://api.service.nhs.uk/dos-search/FHIR/R4","description":"Production"}],"paths":{"/Organization":{"get":{"summary":"Search for organisations by ODS code to return Organisation details (including endpoints managed by the Organisation)","description":"## Overview\nRetrieve an Organisation identified by an ODS code (including endpoints managed by the Organisation).\n\n## Data Dictionary\n\nSuccessful responses return a FHIR `Bundle` containing the matching `Organization` resource together with related `Endpoint` resources as included entries. Response headers are documented separately under `responses` and are intentionally excluded from this data dictionary.\n\n| Field Name | Type | Description |\n|------------|------|-------------|\n| `Organization.id` | `string` | Internal UUID identifying the Organisation |\n| `Organization.identifier` | `string` | Stores the ODS (Organisation Data Service) code identifying the Organisation |\n| `Organization.active` | `boolean` | Whether the Organisation's record is still in active use |\n| `Organization.name` | `string` | Name used for the Organisation |\n| `Endpoint.id` | `string` | Internal UUID identifying the Endpoint |\n| `Endpoint.extension Extension-England-OrganizationEndpointOrder` | `integer` | When multiple endpoints are returned for an Organisation, we need to know the order so that we communicate with the right system first. |\n| `Endpoint.extension Extension-England-EndpointCompression` | `boolean` | Whether the Endpoint uses compression. Compression reduces bandwidth requirements and can reduce messaging delays and/or failure. |\n| `Endpoint.extension Extension-England-EndpointBusinessScenario` | `enum` | Indicates the business scenario for which an Endpoint is intended, particularly distinguishing between primary message recipients and copy recipients for NHS England messaging scenarios. Possible values: <ul><li>`primary-recipient`</li><li>`copy-recipient`</li></ul> |\n| `Endpoint.status` | `enum` | The status of the Endpoint. This tells you if the Endpoint is currently in use. Possible values: <ul><li>`active`</li><li>`off`</li></ul> |\n| `Endpoint.connectionType` | `enum` | Protocol/Profile/Standard to be used with this Endpoint connection. Values include: <ul><li>`itk` (NHS 111 Interoperability Specification)</li><li>`email`</li><li>`telno`</li><li>`http`</li></ul> |\n| `Endpoint.managingOrganization` | `string` | A FHIR reference to the Organisation that manages this Endpoint (might not be the Organisation that exposes the Endpoint) |\n| `Endpoint.payloadType` | `enum` | The type of content that may be used at this Endpoint (e.g. XDS Discharge summaries). Values include: <ul><li>`urn:nhs-itk:interaction:primaryEmergencyDepartmentRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:primaryGeneralPractitionerRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:copyRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:primaryOutofHourRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:primaryNHS111RequestforAmbulance-v2-0`</li><li>`scheduling`</li></ul> |\n| `Endpoint.payloadMimeType` | `enum` | The mime type of the payload to be delivered to this Endpoint. Values include: <ul><li>`application/pdf`</li><li>`text/html`</li><li>`application/fhir+json`</li><li>`application/fhir+xml`</li><li>`message/rfc822` (email)</li><li>`text/vcard` (telno)</li><li>`application/hl7-cda+xml` (CDA)</li></ul> |\n| `Endpoint.address` | `string` | The technical base address for connecting to this Endpoint |\n\n## Request requirements\nA valid ODS code must be provided as a query parameter. An ODS code is deemed valid if it meets the following criteria:\n- it has a minimum of 5 alpha-numeric characters\n- it has a maximum of 12 alpha-numeric characters\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 Organisation and its Endpoints |\n| Any other valid code | `404` Organisation not found |\n\nValidation errors (400) are returned for:\n- Missing `identifier` query parameter\n- Missing `_revinclude` query parameter or value other than `Endpoint:organization`\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 5-12 alphanumeric characters)\n","operationId":"searchOrganizations","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/XRequestID"},{"$ref":"#/components/parameters/XCorrelationID"},{"name":"identifier","in":"query","description":"ODS code in the format \"https://fhir.nhs.uk/Id/ods-organization-code|{CODE}\"","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"pattern":"^https:\\/\\/fhir\\.nhs\\.uk\\/Id\\/ods-organization-code\\|[A-Za-z0-9]{5,12}$","type":"string","example":"https://fhir.nhs.uk/Id/ods-organization-code|ABC123"}},{"name":"_revinclude","in":"query","description":"Include relevant Endpoint resources for requested Organization resource matches in the returned Bundle.\n\nMust be set to `Endpoint:organization`.\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"enum":["Endpoint:organization"],"type":"string","default":"Endpoint:organization","example":"Endpoint:organization"}}],"responses":{"200":{"description":"Successful response","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"example":{"resourceType":"Bundle","id":"87c5f637-cca3-4ddd-97a9-a3f6e6746bbe","type":"searchset","link":[{"relation":"self","url":"https://api.service.nhs.uk/dos-search/FHIR/R4/Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|ABC123&_revinclude=Endpoint:organization"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96","resource":{"resourceType":"Organization","id":"04393ec4-198f-42dd-9507-f4fa5e9ebf96","identifier":[{"use":"official","system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"ABC123"}],"active":true,"name":"Example Organization"},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Endpoint/1b62110d-4db5-4230-bf37-cbe948aecf76","resource":{"resourceType":"Endpoint","id":"1b62110d-4db5-4230-bf37-cbe948aecf76","extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder","valueInteger":1},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression","valueBoolean":false},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario","valueCode":"primary-recipient"}],"status":"active","connectionType":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnection","code":"email"},"managingOrganization":{"reference":"Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96"},"payloadType":[{"coding":[{"system":"http://hl7.org/fhir/ValueSet/endpoint-payload-type","code":"urn:nhs-itk:interaction:primaryGeneralPractitionerRecipientNHS111CDADocument-v2-0"}]}],"payloadMimeType":["application/pdf"],"address":"dummy-endpoint-email@nhs.net"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Endpoint/5df57f63-7f48-5754-b056-ba362834c1e7","resource":{"resourceType":"Endpoint","id":"5df57f63-7f48-5754-b056-ba362834c1e7","extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder","valueInteger":2},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression","valueBoolean":false},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario","valueCode":"copy-recipient"}],"status":"active","connectionType":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnection","code":"email"},"managingOrganization":{"reference":"Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96"},"payloadType":[{"coding":[{"system":"http://hl7.org/fhir/ValueSet/endpoint-payload-type","code":"urn:nhs-itk:interaction:copyRecipientNHS111CDADocument-v2-0"}]}],"payloadMimeType":["application/pdf"],"address":"dummy-endpoint-email@nhs.net"},"search":{"mode":"include"}}]}}}},"400":{"description":"Bad request","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"examples":{"missing-headers":{"$ref":"#/components/examples/MissingHeaders"},"missing-query-parameters":{"$ref":"#/components/examples/MissingQueryParameters"},"invalid-version-header":{"$ref":"#/components/examples/InvalidVersionHeader"},"invalid-request-id":{"$ref":"#/components/examples/InvalidRequestId"},"invalid-identifier-value":{"$ref":"#/components/examples/InvalidIdentifierValue"},"invalid-identifier-system":{"$ref":"#/components/examples/InvalidIdentifierSystem"},"unexpected-header":{"$ref":"#/components/examples/UnexpectedHeader"},"unexpected-query-param":{"summary":"Unexpected query parameter","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode","version":"1.0.0","code":"INVALID_SEARCH_DATA","display":"Invalid search data"}]},"diagnostics":"Unexpected query parameter(s): foo. Only 'identifier' and '_revinclude' are allowed."}]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"deprecated":false,"security":[{"app-level3":[]}]}},"/HealthcareService":{"get":{"summary":"Search for HealthcareService resources by ODS code","description":"> **Note:** This endpoint is published for transparency and onboarding purposes only. It is **not yet available for use** in UAT or Production environments.\n\n## Overview\nSearch for HealthcareService resources. Currently supports searching by managing organization (ODS code).\n\n## Opening Time Semantics\n- `availableTime` represents baseline recurring weekly hours.\n- `notAvailable` represents explicit date closures and takes priority over `availableTime` for the same date.\n- `Slot` entries represent dated opening-time overrides for specific days and/or configured public holiday openings. They take priority over `availableTime` for the same date.\n- Bank holidays are assumed closed unless an explicit bank-holiday opening override is present as a `Slot`.\n\n## Data Dictionary\n\n| Field Name | Type | Description |\n|------------|------|-------------|\n| `Bundle.id` | `string` | UUID representing transaction identifier |\n| `HealthcareService.id` | `string` | Internal UUID identifying the HealthcareService |\n| `HealthcareService.type` | `string` | Type of service (e.g., Pharmacy, GP) |\n| `HealthcareService.telecom` | `enum` | Contact details for the service |\n| `HealthcareService.eligibility` | `enum` | Eligibility requirements to use the service |\n| `HealthcareService.eligibility Extension-England-HealthcareServiceEligibility` | `array` | Holds extensions for healthcare service eligibility |\n| `HealthcareService.eligibility Extension-England-HealthcareServiceEligibility restricted` | `boolean` | Whether the list of assigned GPs are restricted or not |\n| `HealthcareService.eligibility Extension-England-HealthcareServiceEligibility services` | `array` | The list of GPs organisations of the org type of GP Practice assigned to this service |\n| `HealthcareService.providedBy` | `string` | Reference to organization providing the service |\n| `HealthcareService.location` | `string` | Reference to location(s) where service is provided |\n| `HealthcareService.availableTime` | `array` | Recurring weekly baseline opening times for the service |\n| `HealthcareService.notAvailable` | `array` | Explicit single-date closures for the service (takes priority over `availableTime` on the same date) |\n| `HealthcareService.endpoint` | `array` | Reference to technical endpoints for service interactions |\n| `HealthcareService.category` | `array` | High-level categorization of the service as CodeableConcept-like objects with `coding` (for example, GP Services) |\n| `HealthcareService.characteristic` | `array` | Service characteristics represented as CodeableConcept-like objects with `coding` (for example, indicating whether the service is national) |\n| `HealthcareService.comment` | `string` | Free-text comment for the service. |\n| `HealthcareService.referralMethod` | `array` | How a patient may be referred to or access the service. |\n| `QuestionnaireResponse` | `object` | Capacity status information with NHS CodeSystem values |\n| `Schedule` | `object` | Container resource for opening time overrides linked to a HealthcareService |\n| `Slot` | `object` | Time-bounded opening time override instances, including dated variations and public holiday openings (takes priority over `availableTime` on the same date) |\n| `Organization` | `object` | Organization details (when using _include parameter) |\n| `Location.id` | `string` | Internal UUID identifying the Location |\n| `Location.status` | `enum` | Whether the location is active. Possible values: <ul><li>`active`</li><li>`inactive`</li></ul> |\n| `Location.name` | `string` | Name of the location |\n| `Location.address.line` | `array` | Street address lines |\n| `Location.address.city` | `string` | City/town name |\n| `Location.address.district` | `string` | County/district |\n| `Location.address.postalCode` | `string` | Postal code |\n| `Location.address.country` | `string` | Country code (always `GB`) |\n| `Location.extension https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension (UPRN)` | `string` | Unique Property Reference Number (UPRN) for the location, represented as `Location.extension[0].extension[0].valueString` |\n| `Location.position.longitude` | `decimal` | Longitude coordinate |\n| `Location.position.latitude` | `decimal` | Latitude coordinate |\n| `Endpoint.id` | `string` | Internal UUID identifying the Endpoint |\n| `Endpoint.status` | `enum` | The status of the Endpoint. Possible values: <ul><li>`active`</li><li>`off`</li></ul> |\n| `Endpoint.connectionType` | `enum` | Protocol/Profile/Standard for this Endpoint connection. Values include: <ul><li>`itk`</li><li>`email`</li><li>`telno`</li><li>`http`</li></ul> |\n| `Endpoint.managingOrganization` | `string` | FHIR reference to the Organisation that manages this Endpoint |\n| `Endpoint.payloadType` | `enum` | The type of content that may be used at this Endpoint (e.g. XDS Discharge summaries). Values include: <ul><li>`urn:nhs-itk:interaction:primaryEmergencyDepartmentRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:primaryGeneralPractitionerRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:copyRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:primaryOutofHourRecipientNHS111CDADocument-v2-0`</li><li>`urn:nhs-itk:interaction:primaryNHS111RequestforAmbulance-v2-0`</li><li>`scheduling`</li></ul> |\n| `Endpoint.payloadMimeType` | `enum` | The mime type of the payload to be delivered to this Endpoint. Values include: <ul><li>`application/pdf`</li><li>`text/html`</li><li>`application/fhir+json`</li><li>`application/fhir+xml`</li><li>`message/rfc822` (email)</li><li>`text/vcard` (telno)</li><li>`application/hl7-cda+xml` (CDA)</li></ul> |\n| `Endpoint.address` | `string` | The technical base address for connecting to this Endpoint |\n| `Endpoint.extension Extension-England-OrganizationEndpointOrder` | `positiveInt` | Order priority when multiple endpoints exist, represented using `valuePositiveInt` |\n| `Endpoint.extension Extension-England-EndpointCompression` | `boolean` | Whether the Endpoint uses compression |\n| `Endpoint.extension Extension-England-EndpointBusinessScenario` | `enum` | Business scenario for the Endpoint. Possible values: <ul><li>`primary-recipient`</li><li>`copy-recipient`</li></ul> |\n| `Endpoint.extension extension-England-Endpoint.description` | `string` | Free text description of the Endpoint, represented using `valueString` |\n\n## Sandbox testing\nUse the sandbox environment to test this endpoint without affecting real data.\n\n| ODS Code | `_include` values | Response |\n|----------|-------------------|----------|\n| `ABC123` | _(any combination)_ | `200` Returns a Bundle containing the matching HealthcareService, with Location, Organization, and/or Endpoint entries included for each requested `_include` value |\n| Any other valid code | _(any)_ | `400` Bad request — no match found in sandbox data |\n\nValidation errors (400) are returned for:\n- Missing `organization.identifier` query parameter\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 5-12 alphanumeric characters)\n","operationId":"searchHealthcareServices","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/XRequestID"},{"$ref":"#/components/parameters/XCorrelationID"},{"name":"organization.identifier","in":"query","description":"Search for HealthcareService resources managed by a specific organization.\nUse the format \"https://fhir.nhs.uk/Id/ods-organization-code|{ODS_CODE}\"\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"pattern":"^https:\\/\\/fhir\\.nhs\\.uk\\/Id\\/ods-organization-code\\|[A-Za-z0-9]{5,12}$","type":"string","example":"https://fhir.nhs.uk/Id/ods-organization-code|ABC123"}},{"name":"_include","in":"query","description":"Include related resources in the response Bundle.\nCan be specified multiple times to include different resource types.\n","required":false,"deprecated":false,"allowEmptyValue":false,"style":"form","explode":true,"allowReserved":false,"schema":{"type":"array","items":{"enum":["HealthcareService:location","HealthcareService:endpoint","HealthcareService:organization"],"type":"string"}},"example":["HealthcareService:location"]}],"responses":{"200":{"description":"Successful response - returns a Bundle of HealthcareService resources","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/HealthcareServiceBundle"},"example":{"resourceType":"Bundle","id":"87c5f637-cca3-4ddd-97a9-a3f6e6746bbe","type":"searchset","total":1,"link":[{"relation":"self","url":"https://api.service.nhs.uk/dos-search/FHIR/R4/HealthcareService?organization.identifier=https://fhir.nhs.uk/Id/ods-organization-code|ABC123&_include=HealthcareService:location&_include=HealthcareService:endpoint&_include=HealthcareService:organization"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/HealthcareService/e9f5f15a-7d5d-4a3b-9c8d-2e1f3a4b5c6d","resource":{"resourceType":"HealthcareService","id":"e9f5f15a-7d5d-4a3b-9c8d-2e1f3a4b5c6d","providedBy":{"reference":"Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96","display":"Example NHS Foundation Trust"},"type":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceType","code":"Pharmacy","display":"Test Pharmacy Service"}]}],"category":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceCategory","code":"pharmacy-services","display":"Pharmacy Services"}]}],"characteristic":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceCharacteristic","code":"national-service","display":"This service can handle patients nationally"}]}],"location":[{"reference":"Location/04393ec4-198f-42dd-9507-f4fa5e9ebf96"}],"endpoint":[{"reference":"Endpoint/1b62110d-4db5-4230-bf37-cbe948aecf76"}],"telecom":[{"system":"phone","value":"01234567890","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/contactpoint-comment","valueString":"Public"}]},{"system":"phone","value":"01234567890","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/contactpoint-comment","valueString":"Clinician Access Only"}]},{"system":"email","value":"example@example.com"},{"system":"url","value":"https://www.example.com"}],"eligibility":[{"code":{"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"male","display":"Male"}]}}],"comment":"Please telephone before attending to ensure the service can help you.","referralMethod":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceReferralMethod","code":"require-booking","display":"Require Booking"}]},{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceReferralGuidance","code":"telephone-before-attending","display":"You must telephone this service before attending"}]}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/QuestionnaireResponse/c8cf5547-4dc0-4d38-9ac9-7d2aba9c5f2e","resource":{"resourceType":"QuestionnaireResponse","id":"c8cf5547-4dc0-4d38-9ac9-7d2aba9c5f2e","status":"completed","subject":{"reference":"HealthcareService/e9f5f15a-7d5d-4a3b-9c8d-2e1f3a4b5c6d"},"item":[{"linkId":"capacity-red-amber-green-status","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/service-capacity-rag","code":"green","display":"Green"}}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/FHIR/R4/Schedule/6d017ed2-f0ee-4207-a23b-df2f34a9c4e1","resource":{"resourceType":"Schedule","id":"6d017ed2-f0ee-4207-a23b-df2f34a9c4e1","actor":[{"reference":"HealthcareService/e9f5f15a-7d5d-4a3b-9c8d-2e1f3a4b5c6d"}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/FHIR/R4/Slot/fce7f3e7-7f94-4949-9568-febf0fa0e551","resource":{"resourceType":"Slot","id":"fce7f3e7-7f94-4949-9568-febf0fa0e551","schedule":{"reference":"Schedule/6d017ed2-f0ee-4207-a23b-df2f34a9c4e1"},"status":"free","start":"2026-01-05T13:00:00+00:00","end":"2026-01-05T17:00:00+00:00","comment":"Training day variation"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/FHIR/R4/Slot/95f5f307-5fd4-4de5-93d6-bd40bd6e4cbd","resource":{"resourceType":"Slot","id":"95f5f307-5fd4-4de5-93d6-bd40bd6e4cbd","schedule":{"reference":"Schedule/6d017ed2-f0ee-4207-a23b-df2f34a9c4e1"},"status":"free","start":"2026-04-06T09:00:00+00:00","end":"2026-04-06T17:00:00+00:00","comment":"Easter Monday"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/FHIR/R4/Location/04393ec4-198f-42dd-9507-f4fa5e9ebf96","resource":{"resourceType":"Location","id":"04393ec4-198f-42dd-9507-f4fa5e9ebf96","extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension","extension":[{"url":"UPRN","valueString":"123456789"}]}],"status":"active","name":"Example Healthcare Location","address":{"line":["1 High Street","Floor 2"],"city":"Leeds","district":"West Yorkshire","postalCode":"LS1 1AA","country":"GB"},"position":{"longitude":-1.5491,"latitude":53.8008}},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/FHIR/R4/Endpoint/1b62110d-4db5-4230-bf37-cbe948aecf76","resource":{"resourceType":"Endpoint","id":"1b62110d-4db5-4230-bf37-cbe948aecf76","extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder","valuePositiveInt":1},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression","valueBoolean":false},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario","valueCode":"primary-recipient"}],"status":"active","connectionType":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnection","code":"email"},"managingOrganization":{"reference":"Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96"},"payloadType":[{"coding":[{"system":"http://hl7.org/fhir/ValueSet/endpoint-payload-type","code":"urn:nhs-itk:interaction:primaryGeneralPractitionerRecipientNHS111CDADocument-v2-0"}]}],"payloadMimeType":["application/pdf"],"address":"dummy-endpoint-email@nhs.net"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/FHIR/R4/Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96","resource":{"resourceType":"Organization","id":"04393ec4-198f-42dd-9507-f4fa5e9ebf96","identifier":[{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"ABC123"}],"active":true,"name":"Example NHS Foundation Trust"},"search":{"mode":"include"}}]}}}},"400":{"description":"Bad request","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"examples":{"missing-headers":{"$ref":"#/components/examples/MissingHeaders"},"invalid-version-header":{"$ref":"#/components/examples/InvalidVersionHeader"},"unexpected-header":{"$ref":"#/components/examples/UnexpectedHeader"},"invalid-identifier-value":{"$ref":"#/components/examples/InvalidIdentifierValue"},"invalid-identifier-system":{"$ref":"#/components/examples/InvalidIdentifierSystem"},"invalid-request-id":{"$ref":"#/components/examples/InvalidRequestId"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailableHealthcareService"}},"deprecated":false,"security":[{"app-level3":[]}]}},"/HealthcareService/$search-by-triage-code":{"post":{"summary":"Search for HealthcareService resources by triage code combination","description":"> **Note:** This endpoint is published for transparency and onboarding purposes only. It is **not yet available for use** in UAT or Production environments.\n\n## Overview\nSearch for HealthcareService resources using a combination of triage codes (symptom group, symptom discriminator, disposition), patient demographics (age, sex at birth, GP practice), and geographic location (latitude/longitude).\n\n## Request Body Parameters\n\nSend a FHIR `Parameters` resource in the request body. The following parameters are supported:\n\n| Parameter Name | Cardinality | FHIR Type | Description |\n|----------------|-------------|-----------|-------------|\n| `referral-function` | 1..1 | `valueString` | The referral function or role being sought (e.g. `\"GP\"`). Services profiled with this referral function will be returned. |\n| `triage-symptom-group-code` | 1..1 | `valueCoding` | Symptom group code from NHS Pathways (system: `https://fhir.nhs.uk/CodeSystem/pathways-sg-codes`, code format: `SG####`). |\n| `triage-symptom-discriminator-code` | 1..1 | `valueCoding` | Symptom discriminator code from NHS Pathways (system: `https://fhir.nhs.uk/CodeSystem/pathways-sd-codes`, code format: `SD####`). |\n| `triage-disposition-code` | 1..1 | `valueCoding` | Disposition code from NHS Pathways (system: `https://fhir.nhs.uk/CodeSystem/pathways-dx-codes`, code format: `Dx###`). Denotes the timeframe in which a patient should be seen. |\n| `patient-age` | 1..1 | `valueQuantity` | Patient age expressed as a UCUM quantity (system: `http://unitsofmeasure.org`). Supported unit codes: `a` (years), `mo` (months), `d` (days). Value must be non-negative. Converted to days internally using: `a` × 365.25, `mo` × 30.4375, `d` × 1. |\n| `patient-birthsex` | 1..1 | `valueCodeableConcept` | Patient sex at birth (system: `http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender`). Allowed codes: `M` (Male), `F` (Female), `UN` (Undifferentiated), `UNK` (Unknown). |\n| `patient-location-position` | 1..1 | multi-part | Patient geographic coordinates. Contains two required parts: `latitude` (`valueDecimal`, range -90 to 90) and `longitude` (`valueDecimal`, range -180 to 180). Used for catchment area polygon matching and distance calculation. |\n| `patient-general-practitioner` | 0..1 | `valueIdentifier` | Patient's registered GP practice ODS code (system: `https://fhir.nhs.uk/Id/ods-organization-code`). Used to filter GP-restricted services. If omitted, restricted services will not be returned. |\n| `search-date-time` | 0..1 | `valueDateTime` | Optional timestamp to simulate the search at a future point in time (e.g. `\"2026-03-19T10:30:00Z\"`). Used for scenario testing/modelling. Omit for real clinical scenarios. Echoed back in response as a Parameters resource. |\n\n## Validation Rules\n\n- `patient-location-position.latitude` must be between -90 and 90 inclusive.\n- `patient-location-position.longitude` must be between -180 and 180 inclusive.\n- `patient-age.value` must be a non-negative number.\n- `patient-age.code` must be one of: `a`, `mo`, `d`.\n- `patient-birthsex` code must be one of: `M`, `F`, `UN`, `UNK`.\n- `triage-disposition-code` code must match pattern `Dx` followed by digits (case-insensitive).\n- If an invalid SG/SD/DX combination is provided, a catch-all response (501) is returned rather than a validation error.\n\n## GP Restriction Logic\n\n- **Restricted service** (`isRestricted: true`): Only returned if the patient's GP ODS code is in the service's linked GP list. If `patient-general-practitioner` is omitted, restricted services are excluded.\n- **Unrestricted service** (`isRestricted: false`): Always returned regardless of GP ODS code. Services matching the patient's GP are ranked higher.\n\n## Response Structure\n\nSuccessful responses return a FHIR `Bundle` of type `searchset`. Results are grouped by HealthcareService, with each group containing:\n\n| Entry # | Resource | search.mode | Description |\n|---------|----------|-------------|-------------|\n| 1 | `HealthcareService` | `match` | The primary matched service |\n| 2 | `Location` | `include` | Service location (includes distance extension) |\n| 3 | `QuestionnaireResponse` | `include` | Capacity status (RAG) |\n| 4 | `Organization` | `include` | Providing organisation |\n| 5..n | `Endpoint` | `include` | Service endpoints |\n| n+1 | `Schedule` | `include` | Only if opening time overrides exist |\n| n+2..m | `Slot` | `include` | One per variation/public holiday entry |\n| last | `Parameters` | `include` | Only if `search-date-time` was passed in request |\n\nThe Location entry includes a `search.extension` with the `location-distance` extension providing the distance (in miles) from the patient's coordinates to the service location.\n","operationId":"searchHealthcareServicesByTriageCode","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/XRequestID"},{"$ref":"#/components/parameters/XCorrelationID"},{"name":"case-reference-id","in":"header","description":"A globally unique identifier for the case record representing the clinical scenario on the consumer side.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"2c8b5e80-87b6-4d34-9c0b-c18de0c6b550"}},{"name":"case-id","in":"header","description":"A friendly identifier for the case record representing the clinical scenario on the consumer side.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"CASE-12345"}}],"requestBody":{"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/SearchByTriageParameters"},"example":{"resourceType":"Parameters","parameter":[{"name":"referral-function","valueString":"GP"},{"name":"patient-location-position","part":[{"name":"latitude","valueDecimal":53.7997},{"name":"longitude","valueDecimal":-1.5492}]},{"name":"patient-general-practitioner","valueIdentifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"B85002"}},{"name":"patient-age","valueQuantity":{"system":"http://unitsofmeasure.org","value":22,"code":"a"}},{"name":"patient-birthsex","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender","code":"M"}]}},{"name":"triage-disposition-code","valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/pathways-dx-codes","code":"Dx012"}},{"name":"triage-symptom-group-code","valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/pathways-sg-codes","code":"SG1137"}},{"name":"triage-symptom-discriminator-code","valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/pathways-sd-codes","code":"SD4001"}},{"name":"search-date-time","valueDateTime":"2026-03-19T10:30:00Z"}]}}},"required":true},"responses":{"200":{"description":"Successful response - returns a Bundle of HealthcareService resources that match the supplied triage criteria","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/SearchByTriageCodeBundle"},"example":{"resourceType":"Bundle","id":"2d8b4e9d-3df5-4f1c-9f22-6d2ef8b5b801","type":"searchset","timestamp":"2026-03-19T10:30:00Z","total":15,"entry":[{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/HealthcareService/a1b2c3d4-e5f6-7890-abcd-ef1234567890","resource":{"resourceType":"HealthcareService","id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","active":true,"providedBy":{"reference":"Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96","display":"Example Organization"},"category":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceCategory","code":"gp-services","display":"GP Services"}]}],"type":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceType","code":"gp-consultation-service","display":"GP Consultation Service"}]}],"comment":"Walk-in patients are welcome. Please bring a valid form of ID and your NHS number if known. Wheelchair accessible. Interpreter services available on request.","telecom":[{"system":"phone","value":"01131234567","use":"work","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/contactpoint-comment","valueString":"Public"}]},{"system":"phone","value":"01139876543","use":"work","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/contactpoint-comment","valueString":"Clinician Access Only"}]},{"system":"email","value":"contactus@example.org","use":"work"},{"system":"url","value":"https://www.leedscitymedical.nhs.uk","use":"work"}],"location":[{"reference":"Location/7e31b4c4-9f9e-4ab9-a8f0-1eb8f67838b4","display":"Leeds City Medical Practice"}],"eligibility":[{"code":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender","code":"M","display":"Male"}]}},{"extension":[{"extension":[{"url":"restricted","valueBoolean":true},{"url":"services","valueReference":{"reference":"Organization/617a7e73-0f01-43f1-a115-232b3d57f3c3"}}],"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-HealthcareServiceEligibility"}]}],"characteristic":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceCharacteristic","code":"national-service","display":"This service can handle patients nationally"}]},{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceCharacteristic","code":"cannot-attend-in-person","display":"You can't go to this service directly"}]}],"referralMethod":[{"text":"Referrals should be made via the NHS e-Referral Service (e-RS). Please include the patient's NHS number, a summary of the triage outcome, and the Dx code."},{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceReferralMethod","code":"require-booking","display":"Require Booking"}]},{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceReferralMethod","code":"website-signposting","display":"Website Signposting"}]},{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceReferralMethod","code":"inform-service-of-referral","display":"Inform Service of Referral"}]}],"availableTime":[{"daysOfWeek":["mon","tue","wed","thu","fri"],"availableStartTime":"08:00:00","availableEndTime":"12:00:00"},{"daysOfWeek":["mon","tue","wed","thu","fri"],"availableStartTime":"13:00:00","availableEndTime":"20:00:00"},{"daysOfWeek":["sat"],"availableStartTime":"09:00:00","availableEndTime":"17:00:00"},{"daysOfWeek":["sun"],"availableStartTime":"10:00:00","availableEndTime":"16:00:00"}],"notAvailable":[{"description":"Closed","during":{"start":"2026-04-03","end":"2026-04-06"}}],"endpoint":[{"reference":"Endpoint/1b62110d-4db5-4230-bf37-cbe948aecf76"},{"reference":"Endpoint/5df57f63-7f48-5754-b056-ba362834c1e7"}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Location/7e31b4c4-9f9e-4ab9-a8f0-1eb8f67838b4","resource":{"resourceType":"Location","id":"7e31b4c4-9f9e-4ab9-a8f0-1eb8f67838b4","extension":[{"extension":[{"url":"UPRN","valueString":"0008755622"}],"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension"}],"status":"active","name":"Leeds City Medical Practice","address":{"use":"work","type":"physical","line":["2 Great George Street","Leeds City Centre"],"city":"Leeds","district":"West Yorkshire","postalCode":"LS1 3EX","country":"GB"},"position":{"longitude":-1.5518,"latitude":53.7998}},"search":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/location-distance","valueDistance":{"value":0.3,"unit":"miles","system":"http://unitsofmeasure.org","code":"[mi_i]"}}],"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/QuestionnaireResponse/a941d345-9e7a-4fe4-ad74-579c7037faa2","resource":{"resourceType":"QuestionnaireResponse","id":"a941d345-9e7a-4fe4-ad74-579c7037faa2","status":"completed","subject":{"reference":"HealthcareService/a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"item":[{"linkId":"capacity-status","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-CapacityStatus","code":"green","display":"Green"}}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Organization/04393ec4-198f-42dd-9507-f4fa5e9ebf96","resource":{"resourceType":"Organization","id":"04393ec4-198f-42dd-9507-f4fa5e9ebf96","identifier":[{"use":"official","system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"ABC123"}],"active":true,"name":"Example Organization"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Endpoint/1b62110d-4db5-4230-bf37-cbe948aecf76","resource":{"resourceType":"Endpoint","id":"1b62110d-4db5-4230-bf37-cbe948aecf76","extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder","valueInteger":1},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression","valueBoolean":false},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario","valueCode":"primary-recipient"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description","valueString":"Example optional free text note to support use of endpoint, may be user facing."}],"status":"active","connectionType":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnectionType","code":"email"},"payloadType":[{"coding":[{"system":"http://hl7.org/fhir/ValueSet/endpoint-payload-type","code":"urn:nhs-itk:interaction:primaryGeneralPractitionerRecipientNHS111CDADocument-v2-0"}]}],"payloadMimeType":["application/pdf"],"address":"dummy-endpoint-email@nhs.net"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Endpoint/5df57f63-7f48-5754-b056-ba362834c1e7","resource":{"resourceType":"Endpoint","id":"5df57f63-7f48-5754-b056-ba362834c1e7","extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder","valueInteger":2},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression","valueBoolean":false},{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario","valueCode":"copy-recipient"},{"url":"http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description","valueString":"Example optional free text note to support use of endpoint, may be user facing."}],"status":"active","connectionType":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnectionType","code":"email"},"payloadType":[{"coding":[{"system":"http://hl7.org/fhir/ValueSet/endpoint-payload-type","code":"urn:nhs-itk:interaction:copyRecipientNHS111CDADocument-v2-0"}]}],"payloadMimeType":["application/pdf"],"address":"dummy-endpoint-email@nhs.net"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Schedule/49cf4579-a755-467b-b95c-e308a890824a","resource":{"resourceType":"Schedule","id":"49cf4579-a755-467b-b95c-e308a890824a","active":true,"actor":[{"reference":"HealthcareService/a1b2c3d4-e5f6-7890-abcd-ef1234567890","display":"Example Organization - GP Consultation Service"}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Slot/2d41cc47-6ac2-4761-bc61-d6bb5562e434","resource":{"resourceType":"Slot","id":"2d41cc47-6ac2-4761-bc61-d6bb5562e434","schedule":{"reference":"Schedule/49cf4579-a755-467b-b95c-e308a890824a"},"status":"free","comment":"Easter Sunday","start":"2026-04-06T09:00:00+00:00","end":"2026-04-06T17:00:00+00:00"},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/dos-search/FHIR/R4/Parameters/b3c4d5e6-f7a8-9012-bcde-f34567890abc","resource":{"resourceType":"Parameters","id":"b3c4d5e6-f7a8-9012-bcde-f34567890abc","parameter":[{"name":"search-date-time","valueDateTime":"2026-03-19T10:30:00Z"}]},"search":{"mode":"include"}}]}}}},"400":{"description":"Bad request","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"examples":{"missing-headers":{"$ref":"#/components/examples/MissingHeaders"},"invalid-version-header":{"$ref":"#/components/examples/InvalidVersionHeader"},"invalid-request-id":{"$ref":"#/components/examples/InvalidRequestId"},"unexpected-header":{"$ref":"#/components/examples/UnexpectedHeader"},"invalid-json-body":{"$ref":"#/components/examples/InvalidJsonBody"},"invalid-latitude":{"$ref":"#/components/examples/InvalidLatitude"},"invalid-longitude":{"$ref":"#/components/examples/InvalidLongitude"},"invalid-lat-lon-incomplete":{"$ref":"#/components/examples/InvalidLatLonIncomplete"},"invalid-patient-age":{"$ref":"#/components/examples/InvalidPatientAge"},"invalid-patient-age-unit":{"$ref":"#/components/examples/InvalidPatientAgeUnit"},"invalid-patient-birthsex":{"$ref":"#/components/examples/InvalidPatientBirthsex"},"invalid-disposition-code":{"$ref":"#/components/examples/InvalidDispositionCode"},"invalid-sg-code":{"$ref":"#/components/examples/InvalidSGCode"},"invalid-sd-code":{"$ref":"#/components/examples/InvalidSDCode"},"invalid-system-uri":{"$ref":"#/components/examples/InvalidSystemUri"},"duplicate-parameter":{"$ref":"#/components/examples/DuplicateParameter"},"invalid-gp-ods-code":{"$ref":"#/components/examples/InvalidGPOdsCode"},"required-parameter-missing":{"$ref":"#/components/examples/RequiredParameterMissing"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"},"501":{"description":"Invalid SG/SD/DX combination","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}},"503":{"$ref":"#/components/responses/ServiceUnavailableTriageSearch"}},"deprecated":false,"security":[{"app-level3":[]}]}}},"components":{"schemas":{"Bundle":{"required":["resourceType","type","entry"],"type":"object","properties":{"resourceType":{"enum":["Bundle"],"type":"string"},"id":{"type":"string","format":"uuid"},"type":{"enum":["searchset"],"type":"string"},"link":{"type":"array","items":{"type":"object","properties":{"relation":{"type":"string"},"url":{"type":"string","format":"uri"}}}},"entry":{"type":"array","items":{"type":"object","properties":{"fullUrl":{"type":"string","format":"uri"},"resource":{"oneOf":[{"$ref":"#/components/schemas/Organization"},{"$ref":"#/components/schemas/Endpoint"},{"$ref":"#/components/schemas/Location"},{"$ref":"#/components/schemas/HealthcareService"},{"$ref":"#/components/schemas/QuestionnaireResponse"},{"$ref":"#/components/schemas/Schedule"},{"$ref":"#/components/schemas/Slot"}]},"search":{"type":"object","properties":{"mode":{"enum":["match","include"],"type":"string"}}}}}}},"description":"A FHIR resource for the collection of FHIR resources returned in a contained manner."},"HealthcareServiceBundle":{"required":["resourceType","type","entry"],"type":"object","properties":{"resourceType":{"enum":["Bundle"],"type":"string"},"id":{"type":"string","format":"uuid"},"type":{"enum":["searchset"],"type":"string"},"link":{"type":"array","items":{"type":"object","properties":{"relation":{"type":"string"},"url":{"type":"string","format":"uri"}}}},"entry":{"type":"array","items":{"type":"object","properties":{"fullUrl":{"type":"string","format":"uri"},"resource":{"oneOf":[{"$ref":"#/components/schemas/Organization"},{"$ref":"#/components/schemas/HealthcareServiceEndpoint"},{"$ref":"#/components/schemas/Location"},{"$ref":"#/components/schemas/HealthcareService"},{"$ref":"#/components/schemas/QuestionnaireResponse"},{"$ref":"#/components/schemas/Schedule"},{"$ref":"#/components/schemas/Slot"}]},"search":{"type":"object","properties":{"mode":{"enum":["match","include"],"type":"string"}}}}}}},"description":"A FHIR resource for the collection of FHIR resources returned from the HealthcareService endpoint."},"Organization":{"required":["resourceType","identifier","active","name"],"type":"object","properties":{"resourceType":{"enum":["Organization"],"type":"string"},"id":{"type":"string","format":"uuid"},"identifier":{"type":"array","items":{"type":"object","properties":{"use":{"enum":["official"],"type":"string"},"system":{"type":"string"},"value":{"type":"string"}}}},"active":{"type":"boolean"},"name":{"type":"string"},"endpoint":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"}}}}},"description":"A FHIR resource that returns the included components."},"Endpoint":{"required":["resourceType","status","connectionType","payloadType","address"],"type":"object","properties":{"resourceType":{"enum":["Endpoint"],"type":"string"},"id":{"type":"string","format":"uuid"},"identifier":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}}}},"status":{"enum":["active","off"],"type":"string"},"connectionType":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"}}},"payloadType":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","description":"The URI populated in Coding.system for the payload type. The current API output uses the bound ValueSet URL."},"code":{"type":"string","description":"The payload type code selected from the bound value set."}}}}}},"description":"The payload content types supported by the endpoint. This element is bound to the HL7 FHIR ValueSet `http://hl7.org/fhir/ValueSet/endpoint-payload-type`. The current API output populates `Coding.system` with that ValueSet URL and `Coding.code` with the selected payload type code.\n"},"payloadMimeType":{"type":"array","items":{"type":"string"}},"address":{"type":"string","format":"uri"},"extension":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"valueInteger":{"type":"integer"},"valueBoolean":{"type":"boolean"},"valueCode":{"type":"string"}}}},"managingOrganization":{"type":"object","properties":{"reference":{"type":"string"}}},"description":{"type":"string"}},"description":"A FHIR resource that returns the included components."},"HealthcareServiceEndpoint":{"required":["resourceType","status","connectionType","payloadType","address"],"type":"object","properties":{"resourceType":{"enum":["Endpoint"],"type":"string"},"id":{"type":"string","format":"uuid"},"identifier":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}}}},"status":{"enum":["active","off"],"type":"string"},"connectionType":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"}}},"payloadType":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"}}}}}}},"payloadMimeType":{"type":"array","items":{"type":"string"}},"address":{"type":"string","format":"uri"},"extension":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"valuePositiveInt":{"minimum":1.0,"type":"integer"},"valueBoolean":{"type":"boolean"},"valueCode":{"type":"string"}}}},"managingOrganization":{"type":"object","properties":{"reference":{"type":"string"}}}},"description":"A FHIR Endpoint resource shape documented for the HealthcareService endpoint."},"Location":{"required":["resourceType","status"],"type":"object","properties":{"resourceType":{"enum":["Location"],"type":"string"},"id":{"type":"string","format":"uuid"},"extension":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","example":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension"},"extension":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","example":"UPRN"},"valueString":{"type":"string"}}}}}}},"name":{"type":"string"},"address":{"type":"object","properties":{"line":{"type":"array","items":{"type":"string"}},"city":{"type":"string"},"district":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}},"position":{"type":"object","properties":{"longitude":{"type":"number","format":"double"},"latitude":{"type":"number","format":"double"}}}},"description":"A FHIR resource representing a location associated with a healthcare service."},"HealthcareService":{"required":["resourceType","id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"resourceType":{"enum":["HealthcareService"],"type":"string"},"type":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}}}}}}},"category":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}}}}}}},"characteristic":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}}}}}}},"telecom":{"type":"array","items":{"type":"object","properties":{"system":{"enum":["phone","email","url"],"type":"string"},"value":{"type":"string"},"extension":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"valueString":{"type":"string"}}}}}}},"eligibility":{"type":"array","items":{"type":"object","properties":{"code":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}}}},"text":{"type":"string"}}},"comment":{"type":"string"}}}},"providedBy":{"type":"object","properties":{"reference":{"type":"string"},"identifier":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}}},"display":{"type":"string"}}},"location":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"}}}},"availableTime":{"type":"array","items":{"type":"object","properties":{"daysOfWeek":{"type":"array","items":{"enum":["mon","tue","wed","thu","fri","sat","sun"],"type":"string"},"description":"Days when this service is available (mon/tue/wed/thu/fri/sat/sun)"},"availableStartTime":{"pattern":"^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$","type":"string","description":"Start time for available time in HH:MM:SS format","example":"09:00:00"},"availableEndTime":{"pattern":"^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$","type":"string","description":"End time for available time in HH:MM:SS format","example":"17:00:00"},"allDay":{"type":"boolean","description":"Always available? e.g. 24 hour service","default":false}}},"description":"Recurring weekly baseline opening times for this healthcare service."},"notAvailable":{"type":"array","items":{"required":["description"],"type":"object","properties":{"description":{"type":"string","description":"Reason presented to the user explaining why time not available","example":"Closed for maintenance"},"during":{"type":"object","properties":{"start":{"type":"string","description":"Closure date","format":"date","example":"2025-12-25"},"end":{"type":"string","description":"Closure date. Currently matches start.","format":"date","example":"2025-12-25"}},"description":"Service not available on the specified date"}}},"description":"Explicit single-date closures for this healthcare service. These closures take priority over availableTime on the same date."},"comment":{"type":"string","description":"Free-text comment for the service."},"referralMethod":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"enum":["https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceReferralMethod","https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceReferralGuidance"],"type":"string"},"code":{"type":"string"},"display":{"type":"string"}}}}}},"description":"How a patient may be referred to or access the service."},"endpoint":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"}}}}},"description":"A FHIR resource representing a healthcare service"},"SearchByTriageCodeBundle":{"required":["resourceType","type","timestamp","entry"],"type":"object","properties":{"resourceType":{"enum":["Bundle"],"type":"string"},"id":{"type":"string","format":"uuid"},"type":{"enum":["searchset"],"type":"string"},"timestamp":{"type":"string","description":"Timestamp of when the search request transaction was completed.","format":"date-time"},"total":{"type":"integer","description":"Total number of entries in the Bundle."},"entry":{"type":"array","items":{"type":"object","properties":{"fullUrl":{"type":"string","format":"uri"},"resource":{"oneOf":[{"$ref":"#/components/schemas/HealthcareService"},{"$ref":"#/components/schemas/Organization"},{"$ref":"#/components/schemas/Location"},{"$ref":"#/components/schemas/Endpoint"},{"$ref":"#/components/schemas/QuestionnaireResponse"},{"$ref":"#/components/schemas/Schedule"},{"$ref":"#/components/schemas/Slot"},{"$ref":"#/components/schemas/SearchByTriageResponseParameters"}],"discriminator":{"propertyName":"resourceType","mapping":{"HealthcareService":"#/components/schemas/HealthcareService","Organization":"#/components/schemas/Organization","Location":"#/components/schemas/Location","Endpoint":"#/components/schemas/Endpoint","QuestionnaireResponse":"#/components/schemas/QuestionnaireResponse","Schedule":"#/components/schemas/Schedule","Slot":"#/components/schemas/Slot","Parameters":"#/components/schemas/SearchByTriageResponseParameters"}}},"search":{"type":"object","properties":{"extension":{"type":"array","items":{"type":"object","properties":{"url":{"enum":["http://hl7.org/fhir/StructureDefinition/location-distance"],"type":"string"},"valueDistance":{"type":"object","properties":{"value":{"type":"number","description":"Distance value (straight-line)."},"unit":{"enum":["miles"],"type":"string"},"system":{"enum":["http://unitsofmeasure.org"],"type":"string"},"code":{"enum":["[mi_i]"],"type":"string"}}}}},"description":"Extensions on the search entry. Used on Location entries to convey the straight-line distance from the patient's coordinates to the service location."},"mode":{"enum":["match","include"],"type":"string"}}}}}}},"description":"A FHIR Bundle of type `searchset` returned by the `$search-by-triage-code` operation. Contains matching HealthcareService resources grouped with their related Location, Organization, Endpoint, QuestionnaireResponse, Schedule, Slot, and optionally Parameters resources. The Location entry includes a `location-distance` search extension providing the straight-line distance from the patient's coordinates to the service."},"SearchByTriageResponseParameters":{"required":["resourceType","parameter"],"type":"object","properties":{"resourceType":{"enum":["Parameters"],"type":"string"},"id":{"type":"string","format":"uuid"},"parameter":{"type":"array","items":{"type":"object","properties":{"name":{"enum":["search-date-time"],"type":"string"},"valueDateTime":{"type":"string","format":"date-time"}}}}},"description":"A FHIR Parameters resource included in the response Bundle when `search-date-time` was passed in the request. Echoes back the search timestamp used."},"SearchByTriageSymptomGroupCoding":{"required":["system","code"],"type":"object","properties":{"system":{"enum":["https://fhir.nhs.uk/CodeSystem/pathways-sg-codes"],"type":"string"},"code":{"type":"string","description":"Symptom group code, e.g. \"SG1137\"."},"display":{"type":"string"}},"additionalProperties":false,"description":"A coding for the triage symptom-group parameter using the NHS Pathways symptom-group code system."},"SearchByTriageSymptomDiscriminatorCoding":{"required":["system","code"],"type":"object","properties":{"system":{"enum":["https://fhir.nhs.uk/CodeSystem/pathways-sd-codes"],"type":"string"},"code":{"type":"string","description":"Symptom discriminator code, e.g. \"SD4001\"."},"display":{"type":"string"}},"additionalProperties":false,"description":"A coding for the triage symptom-discriminator parameter using the NHS Pathways symptom-discriminator code system."},"SearchByTriageDispositionCoding":{"required":["system","code"],"type":"object","properties":{"system":{"enum":["https://fhir.nhs.uk/CodeSystem/pathways-dx-codes"],"type":"string"},"code":{"type":"string","description":"Disposition code, e.g. \"Dx012\"."},"display":{"type":"string"}},"additionalProperties":false,"description":"A coding for the triage disposition parameter using the NHS Pathways disposition code system."},"SearchByTriageBirthsexCoding":{"type":"object","oneOf":[{"required":["system","code"],"properties":{"system":{"enum":["http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender"],"type":"string"},"code":{"enum":["M","F","UN"],"type":"string","description":"Birth sex code. M = Male, F = Female, UN = Undifferentiated."}},"additionalProperties":false,"description":"Male, Female, or Undifferentiated — from v3-AdministrativeGender"},{"required":["system","code"],"properties":{"system":{"enum":["http://terminology.hl7.org/CodeSystem/v3-NullFlavor"],"type":"string"},"code":{"enum":["UNK"],"type":"string","description":"Birth sex code. UNK = Unknown."}},"additionalProperties":false,"description":"Unknown — from v3-NullFlavor"}],"description":"A coding for the patient birth sex parameter using concepts from the UK Core Birth Sex value set."},"SearchByTriageParameter":{"oneOf":[{"$ref":"#/components/schemas/SearchByTriageReferralFunctionParameter"},{"$ref":"#/components/schemas/SearchByTriageSymptomGroupCodeParameter"},{"$ref":"#/components/schemas/SearchByTriageSymptomDiscriminatorParameter"},{"$ref":"#/components/schemas/SearchByTriageDispositionCodeParameter"},{"$ref":"#/components/schemas/SearchByTriagePatientAgeParameter"},{"$ref":"#/components/schemas/SearchByTriagePatientBirthsexParameter"},{"$ref":"#/components/schemas/SearchByTriagePatientLocationParameter"},{"$ref":"#/components/schemas/SearchByTriagePatientGPParameter"},{"$ref":"#/components/schemas/SearchByTriageSearchDateTimeParameter"}],"description":"A single FHIR `Parameters.parameter` entry for the `$search-by-triage-code` operation.\nThe request body must include all mandatory parameters (referral-function, patient-location-position,\npatient-age, patient-birthsex, triage-disposition-code, triage-symptom-group-code,\ntriage-symptom-discriminator-code). Optional parameters are patient-general-practitioner and search-date-time.\n","discriminator":{"propertyName":"name","mapping":{"referral-function":"#/components/schemas/SearchByTriageReferralFunctionParameter","triage-symptom-group-code":"#/components/schemas/SearchByTriageSymptomGroupCodeParameter","triage-symptom-discriminator-code":"#/components/schemas/SearchByTriageSymptomDiscriminatorParameter","triage-disposition-code":"#/components/schemas/SearchByTriageDispositionCodeParameter","patient-age":"#/components/schemas/SearchByTriagePatientAgeParameter","patient-birthsex":"#/components/schemas/SearchByTriagePatientBirthsexParameter","patient-location-position":"#/components/schemas/SearchByTriagePatientLocationParameter","patient-general-practitioner":"#/components/schemas/SearchByTriagePatientGPParameter","search-date-time":"#/components/schemas/SearchByTriageSearchDateTimeParameter"}}},"SearchByTriageReferralFunctionParameter":{"required":["name","valueString"],"type":"object","properties":{"name":{"enum":["referral-function"],"type":"string"},"valueString":{"type":"string","description":"The referral function value, e.g. \"GP\"."}},"additionalProperties":false,"description":"The referral function or role being sought (e.g. \"GP\")."},"SearchByTriageSymptomGroupCodeParameter":{"required":["name","valueCoding"],"type":"object","properties":{"name":{"enum":["triage-symptom-group-code"],"type":"string"},"valueCoding":{"$ref":"#/components/schemas/SearchByTriageSymptomGroupCoding"}},"additionalProperties":false,"description":"The symptom group code from NHS Pathways triage."},"SearchByTriageSymptomDiscriminatorParameter":{"required":["name","valueCoding"],"type":"object","properties":{"name":{"enum":["triage-symptom-discriminator-code"],"type":"string"},"valueCoding":{"$ref":"#/components/schemas/SearchByTriageSymptomDiscriminatorCoding"}},"additionalProperties":false,"description":"The symptom discriminator code from NHS Pathways triage."},"SearchByTriageDispositionCodeParameter":{"required":["name","valueCoding"],"type":"object","properties":{"name":{"enum":["triage-disposition-code"],"type":"string"},"valueCoding":{"$ref":"#/components/schemas/SearchByTriageDispositionCoding"}},"additionalProperties":false,"description":"The disposition code (Dx code) from NHS Pathways triage. Denotes the timeframe in which a patient should be seen."},"SearchByTriagePatientAgeParameter":{"required":["name","valueQuantity"],"type":"object","properties":{"name":{"enum":["patient-age"],"type":"string"},"valueQuantity":{"required":["system","value","code"],"type":"object","properties":{"system":{"enum":["http://unitsofmeasure.org"],"type":"string"},"value":{"minimum":0.0,"type":"number","description":"The age value. Must be non-negative."},"code":{"enum":["a","mo","d"],"type":"string","description":"UCUM unit code for the age value. \"a\" = years, \"mo\" = months, \"d\" = days."}},"additionalProperties":false}},"additionalProperties":false,"description":"The patient's age expressed as a UCUM quantity. Converted to days internally using: years (a) × 365.25, months (mo) × 30.4375, days (d) × 1."},"SearchByTriagePatientBirthsexParameter":{"required":["name","valueCodeableConcept"],"type":"object","properties":{"name":{"enum":["patient-birthsex"],"type":"string"},"valueCodeableConcept":{"required":["coding"],"type":"object","properties":{"coding":{"maxItems":1,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SearchByTriageBirthsexCoding"}}}}},"additionalProperties":false,"description":"The patient's sex at birth, using concepts from the UK Core Birth Sex value set."},"SearchByTriagePatientLocationParameter":{"required":["name","part"],"type":"object","properties":{"name":{"enum":["patient-location-position"],"type":"string"},"part":{"maxItems":2,"minItems":2,"type":"array","items":{"required":["name","valueDecimal"],"type":"object","properties":{"name":{"enum":["latitude","longitude"],"type":"string"},"valueDecimal":{"type":"number","description":"Coordinate value. Latitude must be between -90 and 90 inclusive. Longitude must be between -180 and 180 inclusive."}},"additionalProperties":false},"description":"Contains latitude and longitude parts."}},"additionalProperties":false,"description":"The patient's geographic coordinates (latitude and longitude). Used for catchment area polygon matching and distance calculation."},"SearchByTriagePatientGPParameter":{"required":["name","valueIdentifier"],"type":"object","properties":{"name":{"enum":["patient-general-practitioner"],"type":"string"},"valueIdentifier":{"required":["system","value"],"type":"object","properties":{"system":{"enum":["https://fhir.nhs.uk/Id/ods-organization-code"],"type":"string"},"value":{"type":"string","description":"The ODS code of the patient's GP practice."}},"additionalProperties":false}},"additionalProperties":false,"description":"The ODS code of the patient's registered GP practice. Used to filter GP-restricted services. Optional — if omitted, restricted services are excluded."},"SearchByTriageSearchDateTimeParameter":{"required":["name","valueDateTime"],"type":"object","properties":{"name":{"enum":["search-date-time"],"type":"string"},"valueDateTime":{"type":"string","description":"ISO 8601 timestamp, e.g. \"2026-03-19T10:30:00Z\".","format":"date-time"}},"additionalProperties":false,"description":"An optional timestamp to simulate the search at a future point in time. Used for scenario testing/modelling. Omit for real clinical scenarios. The value is echoed back in the response as a Parameters resource."},"SearchByTriageParameters":{"required":["resourceType","parameter"],"type":"object","properties":{"resourceType":{"enum":["Parameters"],"type":"string"},"parameter":{"maxItems":9,"minItems":7,"type":"array","items":{"$ref":"#/components/schemas/SearchByTriageParameter"},"description":"Contains the triage request parameters. The array must include referral-function, triage-symptom-group-code, triage-symptom-discriminator-code, triage-disposition-code, patient-age, patient-birthsex, and patient-location-position. Optionally includes patient-general-practitioner and search-date-time."}},"description":"A FHIR Parameters resource containing the body search inputs for the HealthcareService `$search-by-triage-code` operation. Must include all mandatory parameters: referral-function, triage-symptom-group-code, triage-symptom-discriminator-code, triage-disposition-code, patient-age, patient-birthsex, and patient-location-position. Optional parameters: patient-general-practitioner, search-date-time."},"QuestionnaireResponse":{"required":["resourceType","status","subject","item"],"type":"object","properties":{"resourceType":{"enum":["QuestionnaireResponse"],"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"enum":["completed"],"type":"string"},"subject":{"type":"object","properties":{"reference":{"pattern":"^HealthcareService/[a-fA-F0-9-]+$","type":"string"}},"description":"Reference to the HealthcareService this capacity status relates to"},"item":{"type":"array","items":{"type":"object","properties":{"linkId":{"enum":["capacity-red-amber-green-status"],"type":"string"},"answer":{"type":"array","items":{"type":"object","properties":{"valueCoding":{"type":"object","properties":{"system":{"enum":["https://fhir.nhs.uk/CodeSystem/service-capacity-rag"],"type":"string"},"code":{"enum":["green","amber","red"],"type":"string"},"display":{"enum":["Green","Amber","Red"],"type":"string"}},"description":"Capacity status code"}}}}}},"description":"Capacity status answers"}},"description":"A FHIR resource representing capacity status information for healthcare services"},"Schedule":{"required":["resourceType","actor"],"type":"object","properties":{"resourceType":{"enum":["Schedule"],"type":"string"},"id":{"type":"string","format":"uuid"},"actor":{"minItems":1,"type":"array","items":{"type":"object","properties":{"reference":{"pattern":"^HealthcareService/[a-fA-F0-9-]+$","type":"string"}}}}},"description":"A FHIR resource representing a container for availability override slots linked to a HealthcareService."},"Slot":{"required":["resourceType","schedule","status","start","end"],"type":"object","properties":{"resourceType":{"enum":["Slot"],"type":"string"},"id":{"type":"string","format":"uuid"},"schedule":{"type":"object","properties":{"reference":{"pattern":"^Schedule/[a-fA-F0-9-]+$","type":"string"}}},"status":{"enum":["free"],"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"comment":{"type":"string","description":"Description of the override, for example a named variation or public holiday."}},"description":"A FHIR resource representing a single dated availability override interval. Slot overrides take priority over availableTime for the same date. Bank holidays are assumed closed unless a bank-holiday opening override slot is present."},"OperationOutcome":{"required":["resourceType","issue"],"type":"object","properties":{"resourceType":{"enum":["OperationOutcome"],"type":"string"},"issue":{"type":"array","items":{"required":["severity","code","diagnostics"],"type":"object","properties":{"severity":{"enum":["error","fatal"],"type":"string"},"code":{"enum":["code-invalid","invalid","processing","structure","value","security","forbidden","exception","not-supported","required","throttled"],"type":"string"},"diagnostics":{"type":"string"},"details":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"version":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}}}}}}}}}}}},"responses":{"Unauthorized":{"description":"Unauthorized - Invalid or missing authentication token","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"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"}]}}}},"Forbidden":{"description":"Forbidden - Insufficient permissions to access this resource","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"fatal","code":"forbidden","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"0.1.0","code":"SEND_FORBIDDEN","display":"403: Failed to authenticate with the API."}]},"diagnostics":"Insufficient permissions to access this resource"}]}}}},"TooManyRequests":{"description":"Too many requests – Rate limit exceeded","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"throttled","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"0.1.0","code":"SEND_TOO_MANY_REQUESTS","display":"429: Too many requests have been made by this source to the API in a given amount of time."}]},"diagnostics":"You have exceeded the agreed rate limits for this endpoint. Please retry. If problems persist please contact support."}]}}}},"ServerError":{"description":"Internal server error","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"fatal","code":"exception","diagnostics":"Internal server error"}]}}}},"ServiceUnavailableHealthcareService":{"description":"Service unavailable - the HealthcareService search endpoint is currently disabled via feature flag","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"fatal","code":"exception","diagnostics":"Service Unavailable: Healthcare Service search endpoint is currently disabled"}]}}}},"ServiceUnavailableTriageSearch":{"description":"Service unavailable - the HealthcareService $search-by-triage-code endpoint is currently disabled via feature flag","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"fatal","code":"exception","diagnostics":"Service Unavailable: HealthcareService $search-by-triage-code operation is currently unavailable"}]}}}},"InvalidId":{"description":"Bad request","headers":{"X-Request-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XRequestID"},"X-Correlation-ID":{"name":"","in":"header","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"$ref":"#/components/headers/XCorrelationID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Invalid id parameter value 'foo' - must be a valid UUID","details":{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode","version":"1","code":"INVALID_RESOURCE_ID","display":"Invalid resource ID"}]}}]}}}}},"parameters":{"Authorization":{"name":"Authorization","in":"header","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\nRequired in all environments except sandbox.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},"Version":{"name":"version","in":"header","description":"The major version increment of this API to query.\nMust be a valid non-negative integer representing a supported major version increment of this API.\nThis is a mandatory header.\nIf you receive repeated 400 Bad Requests marking an invalid header, check that you are correctly sending a valid entry for this value.\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"enum":[1],"type":"integer","example":1}},"XRequestID":{"name":"X-Request-ID","in":"header","description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\nMust be a UUIDv4 (GUID).\nMirrored back in a response header.\nThis is a mandatory header. Please make a note of this value if you might need to raise a support ticket, as this value, as well as the value of X-Correlation-ID will be required. *If you re-send a failed request, use the same value in this header.*\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}},"XCorrelationID":{"name":"X-Correlation-ID","in":"header","description":"An optional ID which you can use to track transactions across multiple systems. This header may be a GUID or any other caller-defined value.\nMirrored back in a response header.\nPlease make a note of this value if you might need to raise a support ticket, as this value as well as the value of X-Request-ID will be required.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}}},"examples":{"MissingHeaders":{"summary":"Missing required headers","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"required","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Missing required header(s): 'version', 'x-request-id'"}]}},"MissingQueryParameters":{"summary":"Missing required query parameter","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"required","details":{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode","version":"1.0.0","code":"INVALID_SEARCH_DATA","display":"Invalid search data"}]},"diagnostics":"Missing required query parameter(s): 'identifier', '_revinclude'"}]}},"InvalidLatitude":{"summary":"Invalid latitude value","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid value '100' for parameter 'patient-location-position.latitude': Input should be less than or equal to 90"}]}},"InvalidLongitude":{"summary":"Invalid longitude value","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid value '200' for parameter 'patient-location-position.longitude': Input should be less than or equal to 180"}]}},"InvalidPatientAge":{"summary":"Invalid patient age value","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid value '-5' for parameter 'patient-age': Input should be greater than or equal to 0"}]}},"InvalidPatientBirthsex":{"summary":"Invalid patient birth sex code","value":{"resourceType":"OperationOutcome","issue":[{"severity":"fatal","code":"exception","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid patient-birthsex code 'X': must be one of M, F, UN, UNK"}]}},"InvalidDispositionCode":{"summary":"Invalid disposition code format","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid DX Code value 'ABC' found in supplied parameters: DX code does not follow format '(?i)^DX\\d+$'"}]}},"InvalidVersionHeader":{"summary":"Invalid Version header","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid version found in supplied headers: version must be '1'"}]}},"InvalidIdentifierValue":{"summary":"Invalid ODS code format","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","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 identifier value: ODS code 'ABC' must follow format ^[A-Za-z0-9]{5,12}$"}]}},"InvalidIdentifierSystem":{"summary":"Invalid identifier system","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"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 identifier system 'foo' - expected 'https://fhir.nhs.uk/Id/ods-organization-code'"}]}},"UnexpectedHeader":{"summary":"Unexpected header","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Unexpected header(s): foo."}]}},"InvalidRequestId":{"summary":"Invalid X-Request-ID header","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid header found in supplied headers: x-request-id must be a valid UUIDv4"}]}},"UnexpectedQueryParam":{"summary":"Unexpected query parameter","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode","version":"1.0.0","code":"INVALID_SEARCH_DATA","display":"Invalid search data"}]},"diagnostics":"Unexpected query parameter(s): foo. Only 'identifier' and '_revinclude' are allowed."}]}},"InvalidJsonBody":{"summary":"Invalid JSON request body","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"structure","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Failed to parse request body as JSON resource."}]}},"InvalidLatLonIncomplete":{"summary":"Latitude and longitude must be provided together","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Both latitude and longitude in 'patient-location-position' must be provided together"}]}},"InvalidPatientAgeUnit":{"summary":"Invalid patient age unit code","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid patient-age unit 'x': must be one of a, mo, d"}]}},"InvalidSGCode":{"summary":"Invalid symptom group code format","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid SG Code value 'ABC' found in supplied parameters: SG code does not follow format '(?i)^SG\\d+$'"}]}},"InvalidSDCode":{"summary":"Invalid symptom discriminator code format","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid SD Code value 'ABC' found in supplied parameters: SD code does not follow format '(?i)^SD\\d+$'"}]}},"InvalidSystemUri":{"summary":"Invalid system URI for a parameter","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"code-invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Parameter 'triage-symptom-group-code' has invalid system 'http://example.com', expected 'https://fhir.nhs.uk/CodeSystem/pathways-sg-codes'"}]}},"DuplicateParameter":{"summary":"Duplicate parameter in request body","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Parameter 'triage-symptom-group-code' must not appear more than once"}]}},"InvalidGPOdsCode":{"summary":"Invalid GP practice ODS code format","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Invalid patient-general-practitioner ODS code 'X': must follow format ^[A-Za-z0-9]{5,12}$"}]}},"RequiredParameterMissing":{"summary":"Required body parameter is missing","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"required","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/http-error-codes","version":"1","code":"REC_BAD_REQUEST","display":"400: The Receiver was unable to process the request."}]},"diagnostics":"Parameter 'triage-symptom-group-code' is required"}]}}},"headers":{"XRequestID":{"name":"","in":"header","description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\nMust be a universally unique identifier (UUIDv4).\nMirrored back in a response header.\nThis is a mandatory header. Please make a note of this value if you might need to raise a support ticket, as this value, as well as the value of X-Correlation-ID will be required. *If you re-send a failed request, use the same value in this header.*\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}},"XCorrelationID":{"name":"","in":"header","description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters.\nMirrored back in a response header.\nPlease make a note of this value if you might need to raise a support ticket, as this value as well as the value of X-Request-ID will be required.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}}},"securitySchemes":{"app-level3":{"$ref":"https://proxygen.prod.api.platform.nhs.uk/components/securitySchemes/app-level3"}}},"security":[{"app-level3":[]}],"x-nhsd-apim":{"target-attributes":[{"name":"application-id","required":false,"header":"application-id"},{"name":"application-name","required":false,"header":"application-name"},{"name":"dos-search-authorised-endpoints","required":false,"header":"dos-search-authorised-endpoints"}],"target":{"type":"external","healthcheck":"/_status","url":"https://dos-search.dev.ftrs.cloud.nhs.uk","security":{"type":"mtls","secret":"dos-search-mtls-secret"}},"access":[{"title":"Application-restricted with Private Key JWT","grants":{"app-level3":[]},"visible":true}],"ratelimiting":{"proxy":{"timeunit":"minute","limit":9000},"app-default":{"timeunit":"minute","limit":600}},"monitoring":true,"temporary":false,"depflag":false,"productidcheck":false}}