openapi: 3.0.0
info:
version: 0.0.1
title: e-Referrals Service CodeSystem Organization API
description: "## Overview\nUse this API to create paperless referrals from primary to secondary care with the [e-Referral Service (e-RS)](https://digital.nhs.uk/services/e-referral-service).\n\nFor an overview of how you can plan and prepare for your integration with e-RS, see our [API onboarding guide](https://digital.nhs.uk/services/e-referral-service/api).\n\n**As a primary care referrer, you can:**\n\n -\tcreate a new e-referral\n - search for relevant patient services to create a shortlist\n -\taccess existing e-referrals\n -\tcreate a triage request for the Referral Assessment Service (RAS)\n -\tupload and manage a patient letter or attachments, linking them to a referral\n -\tretrieve appointment slots and book appointments\n -\tdefer a booking to a provider if an appointment slot is unavailable\n - create a new advice and guidance request\n\n**As a secondary care provider, you can:**\n\n -\taccess referrals as a worklist\n -\tretrieve non-clinical information (meta-data) about the referral\n -\tretrieve attachments which are linked to a referral or triage (RAS) request\n -\tretrieve clinical information which has been provided by a referrer\n -\taccept or reject a referral request\n -\tretrieve Advice & Guidance (A&G) conversations and send responses\n -\tconvert Advice & Guidance (A&G) conversations into a referral\n - cancel a referral\n\n**You cannot use this API to:**\n\n -\tget patient details - instead, use the [[HYPERLINK_PDS]]\n\n**You can access the following data:**\n\n -\treferral attachments\n -\treferral letters\n -\tappointment slots\n -\tworklists for referral requests\n -\tworklists for triage (RAS) requests\n -\tworklists for Advice and Guidance (A&G) requests\n -\tconversation histories for Advice and Guidance (A&G) requests\n\n<section class=\"nhsd-m-emphasis-box nhsd-m-emphasis-box--important nhsd-!t-margin-bottom-6\" aria-label=\"Important Information\">\n <div class=\"nhsd-a-box nhsd-a-box--border-yellow\">\n <div class=\"nhsd-m-emphasis-box__image-box\">\n <figure class=\"nhsd-a-image\">\n <picture class=\"nhsd-a-image__picture\">\n <img src=\"data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNS4xLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT48c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIGlkPSJMYXllcl8xIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCAxNDAgMTQwOyIgdmVyc2lvbj0iMS4xIiB2aWV3Qm94PSIwIDAgMTQwIDE0MCIgeD0iMHB4IiB4bWw6c3BhY2U9InByZXNlcnZlIiB5PSIwcHgiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtkaXNwbGF5Om5vbmU7fQoJLnN0MXtkaXNwbGF5OmlubGluZTtmaWxsOiMyMzFmMjA7fQoJLnN0MntmaWxsOiMyMzFmMjA7fQoJLnN0M3tmaWxsOm5vbmU7c3Ryb2tlOiMyMzFmMjA7c3Ryb2tlLXdpZHRoOjEuOTI7c3Ryb2tlLWxpbmVjYXA6cm91bmQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjEwO30KCS5zdDR7ZmlsbDojMjMxZjIwO30KCS5zdDV7ZmlsbDojMjMxZjIwO30KCS5zdDZ7ZmlsbDpub25lO3N0cm9rZTojMjMxZjIwO3N0cm9rZS13aWR0aDo1O3N0cm9rZS1taXRlcmxpbWl0OjEwO30KPC9zdHlsZT4KPGcgY2xhc3M9InN0MCI+Cgk8cGF0aCBjbGFzcz0ic3QxIiBkPSJNNzAsNi45NWw1NCwzMS41djYzLjExbC01NCwzMS41bC01NC0zMS41VjM4LjQ1TDcwLDYuOTUgTTcwLDBMMTAsMzV2NzBsNjAsMzVsNjAtMzVWMzVMNzAsMEw3MCwweiIvPgo8L2c+CjxnPgoJPHBhdGggY2xhc3M9InN0MiIgZD0iTTEwOS44NiwzOS44NXY1NUg4NS43Yy0zLjA2LDAtNS4xNCwzLjA2LTcuMDgsNWgtMTcuNWMtMS45NC0xLjk0LTQuMDMtNS03LjA4LTVIMjkuODd2LTU1aDI1ICAgYzUuMjgsMCwxMC44MywxLjMyLDE1LDQuNzljNC4xNy0zLjQ3LDkuNzItNC43OSwxNS00Ljc5SDEwOS44NnogTTY0Ljg2LDU0Ljg1YzAtMy44OS03LjIyLTUtMTAtNWgtMTV2MzVoMTMuNzUgICBjNS42MiwwLDcuNTcsMC42OSwxMS4yNSw1VjU0Ljg1eiBNOTkuODYsNDkuODVoLTE1Yy0yLjc4LDAtMTAsMS4xMS0xMCw1djM1YzMuNjgtNC4zMSw1LjYyLTUsMTEuMjUtNWgxMy43NVY0OS44NXoiLz4KPC9nPgo8L3N2Zz4K\" alt=\"\" style=\"object-fit:fill\">\n </picture>\n </figure>\n </div>\n <div class=\"nhsd-m-emphasis-box__content-box\" style=\"align-self: center;\">\n <div data-uipath=\"website.contentblock.emphasis.content\" class=\"nhsd-t-word-break\">\n <p class=\"nhsd-t-body\" style=\"margin: 0rem;\">To discover the most common use cases, see our <a\n href=\"https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings/e-referral-service\" onkeyup=\"return vjsu.onKeyUp(event)\" class=\"nhsd-a-link\">Building Healthcare Software guides</a>.</p>\n </div>\n </div>\n </div>\n</section>\n\n### Access modes\n\nThis API has two access modes:\n\n| Access mode | Authentication via | Functions | Availability |\n| ----------------------------- | -------------------------- | ----------------------- | ------------------------------- |\n| Application-restricted,<br/>unattended access | [[HYPERLINK_SIGNED_JWT]] | <ul><li>[[HYPERLINK_A004]]</li><li>[[HYPERLINK_A005]]</li><li>[[HYPERLINK_A007]]</li><li>[[HYPERLINK_A008]]</li><li>[[HYPERLINK_A013]]</li><li>[[HYPERLINK_A024]]</li><li>[[HYPERLINK_A025]]</li><li>[[HYPERLINK_A028]]</li><li>[[HYPERLINK_A029]]</li><li>[[HYPERLINK_A033]]</li><li>[[HYPERLINK_A035]]</li><li>[[HYPERLINK_A036]]</li><li>[[HYPERLINK_A037]]</li><li>[[HYPERLINK_A042]]</li><li>[[HYPERLINK_A043]]</li></ul> | [[HYPERLINK_PRODUCTION]] |\n| Healthcare worker,<br/>user-restricted access | [[HYPERLINK_CIS_AUTH_SHORT]] | All Endpoints | [[HYPERLINK_PRODUCTION]] |\n\n##### Application-restricted, unattended access\n\nThis access mode has been introduced to allow a Partner application which has been [registered with us](https://portal.developer.nhs.uk/create-a-developer-account) and [authenticated via signed JWT](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) to interact with a subset of e-RS FHIR API endpoints in an unattended and read-only fashion.\nApplication-restricted, unattended access should only be used when authenticating a human user (for example via smartcard) is not possible.\n\nWrite operations are currently supported for specific use cases via:\n- [[HYPERLINK_A028]]\n- [[HYPERLINK_A013]]\n- [[HYPERLINK_A036]]\n\nYou will be required to submit your use case for review when using these endpoints via application-restricted, unattended access.\n\n##### Healthcare worker, user-restricted access\n\nThis access mode allows Partner applications to access e-RS FHIR API endpoints by authenticating users with [[HYPERLINK_CIS_AUTH_LONG]].\n\nThis access mode must be used for writing changes (such as Create Referral).\n\n## Who can use this API\n\nYou can use this API if you are a software developer wishing to interact with the e-referrals service (e-RS) data, for use in a professional, clinical setting. \n\nTo use this API you must:\n\n -\thave justification for doing so\n -\t[register with us](https://digital.nhs.uk/services/e-referral-service/api/integration-process/stage-1-design#1-8-register-with-us)\n -\tensure you have a [valid use case](https://digital.nhs.uk/services/e-referral-service/api/integration-process/stage-1-design#1-2-validate-your-use-case) before you go too far with your development\n -\t[assure](https://digital.nhs.uk/services/e-referral-service/api/integration-process/stage-3-assure) your solution before we grant access to live data\n\n## Related APIs\n\n[HL7 V3 API](https://digital.nhs.uk/developer/api-catalogue/e-referral-service-hl7-v3) - this API allows you to manage appointment slots for a Patient Administration System (PAS). \n\n\n## API status and roadmap\n\n### This API has two access modes:\n - Application-restricted, unattended access\n - Healthcare worker, user-restricted access\n\n### Application-restricted, unattended access\n\nThis access mode is [[HYPERLINK_PRODUCTION]], meaning:\n - we avoid making routine [breaking changes](https://digital.nhs.uk/services/e-referral-service/api/updates-and-releases/sunsetting-policy#breaking-changes), except in exceptional circumstances\n - if we need to deprecate an endpoint, we will give advance notice on our [board](https://digital.nhs.uk/services/e-referral-service/api/updates-and-releases/deprecation-notices). Our [sunsetting page](https://digital.nhs.uk/services/e-referral-service/api/updates-and-releases/sunsetting-policy) details our deprecation and retirement policy.\n \n### Healthcare worker, user-restricted access\n\nThis access mode is [[HYPERLINK_PRODUCTION]], meaning:\n - we avoid making routine [breaking changes](https://digital.nhs.uk/services/e-referral-service/api/updates-and-releases/sunsetting-policy#breaking-changes), except in exceptional circumstances\n - if we need to deprecate an endpoint, we will give advance notice on our [board](https://digital.nhs.uk/services/e-referral-service/api/updates-and-releases/deprecation-notices). Our [sunsetting page](https://digital.nhs.uk/services/e-referral-service/api/updates-and-releases/sunsetting-policy) details our deprecation and retirement policy.\n\n### Roadmap\n\nVisit our [roadmap page](https://digital.nhs.uk/services/e-referral-service/api/updates-and-releases/roadmap) for details of what we are working on.\n\nTo suggest, comment or vote on features for this API, see our [interactive product backlog](https://portal.productboard.com/qhpkcqgctqtk3ujk8jyoajp8/tabs/4-new-requests).\n\n## Service level\nThis API is a gold service, meaning it is operational and supported 24 hours a day, 365 days a year.\n\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\n\nThis API is primarily [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#basic-rest) \nand based on [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir) global standards for health care data exchange.\n\nThis API supports FHIR STU3 and FHIR R4.\n\n### FHIR STU3\n\nThe e-RS FHIR STU3 API is built against the set of profiles called [CareConnect](https://nhsconnect.github.io/CareConnectAPI/).\n\n### FHIR R4\n\nThe e-RS FHIR R4 API is built alongside the [NHS England FHIR Implementation Guide](https://simplifier.net/guide/nhsdigital), which is built on top of [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core). The canonical URLs listed in the schema can be resolved with [https://simplifier.net/resolve](https://simplifier.net/resolve).\n\n## Network access\n\nThis API is available on the internet and, indirectly, on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network).\n\nTo use this API with NHS smartcards you do need an HSCN connection, although internet-facing alternatives are available.\n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n\n## Security and authorisation\n\nThis API has two access modes:\n- Application-restricted, unattended access\n- Healthcare worker, user-restricted access\n\n### Application-restricted, unattended access\n\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate the calling application but not the end user.\n\nYou can only use this access mode when authenticating a human user (for example via smartcard) is not possible.\n\nWrite operations are currently only supported by [[HYPERLINK_A028]] for non-clinical use cases. You will be required to submit your use case for review when using this endpoint via application-restricted, unattended access.\n\nTo use this access mode, use the following security pattern:\n- [Application-restricted RESTful API - signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\n\n### Healthcare worker, user-restricted access\n\nThis access mode is [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis), meaning an end user must be present, authenticated and authorised.\n\nThe end user must be:\n- present\n- a healthcare worker\n- strongly authenticated and authorised by [[HYPERLINK_CIS_AUTH_LONG]]\n\nIn order to successfully authenticate with CIS2, the NHS e-Referral Service requires end users to be authenticated to the following standards:\n - an [Identity Assurance Level (IAL)](https://digital.nhs.uk/services/care-identity-service/applications-and-services/cis2-authentication/guidance-for-developers/detailed-guidance/scopes-and-claims#claims ) of IAL3\n - an [Authenticator Assurance Level (AAL)](https://digital.nhs.uk/services/care-identity-service/applications-and-services/cis2-authentication/guidance-for-developers/detailed-guidance/acr-values#authentication-methods) of AAL2 or AAL3\n\nTo use this access mode, use one of the following security patterns:\n- [user-restricted RESTful API - using NHS CIS2 - combined authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-combined-authentication-and-authorisation)\n- [user-restricted RESTful API - using NHS CIS2 - separate authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-separate-authentication-and-authorisation)\n\nWe strongly recommend the use of <b>separate</b> authentication and authorisation. This mode will provide you access to the healthcare workers identity, allowing you to reuse it across multiple applications such as PDS.\n\nYou can [learn more](https://digital.nhs.uk/services/e-referral-service/api/integration-process/stage-1.4---select-your-authentication-level#1-access-modes) about each access mode option on our onboarding guide.\n\n#### Role and Organisation Validation\nFor most e-RS endpoints requests are made in the context of a specific authorised e-RS Role at a specific Organisation for the authenticated user. \n\nThe e-RS Role is supplied to the endpoint via the `NHSD-eRS-Business-Function` request header. \n\nThe Organisation is supplied to the endpoint via the `NHSD-End-User-Organisation-ODS` request header. \n\nSuitable values for these request headers can be obtained from the Practitioner Role Bundle returned by [[HYPERLINK_A030]].\n\n#### On Behalf Of User\nIf the `SERVICE_PROVIDER_CLINICIAN_ADMIN` role is used then the User ID of the Service Provider Clinician that the Admin is acting on behalf of must be supplied via the `NHSD-eRS-On-Behalf-Of-User-ID` header.\n\n\"On behalf of\" is only supported for a Service Provider Clinician Admin (SPCA) acting on behalf of a Service Provider Clinician (SPC).\n\n## Environments and testing\n\n| Environment | Base URL |\n| ----------------- | ---------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/referrals/FHIR` |\n| Integration test | `https://int.api.service.nhs.uk/referrals/FHIR` |\n| Production | `https://api.service.nhs.uk/referrals/FHIR` |\n\n### Sandbox testing\n\nOur [sandbox](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing) environment:\n-\tis for developer education and early testing\n-\tonly covers a limited set of scenarios\n-\tis stateless, so does not actually persist any updates\n-\tis open access, so does not allow you to test authorisation\n\nTry out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\n\nThe sandbox will only respond to an input which exactly matches one of the examples provided; it is otherwise stateless.\n\n### Integration testing\n\nOur [integration test](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis) environment:\n -\tis where the majority of your integration efforts will take place\n - is where we conduct witness testing for your application\n -\tis stateful, so data will be persisted\n\n\n## Onboarding\n\nYou need to get your software approved by us before you 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\nWe use the Supplier Conformance Assessment List (SCAL) process. [Learn more](https://digital.nhs.uk/services/e-referral-service/api/integration-process/stage-1-design#1-7-learn-how-to-onboard) about onboarding.\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\nErrors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n"
contact:
url: https://digital.nhs.uk/developer/help-and-support
email: api.management@nhs.net
license:
name: MIT
servers:
- url: https://sandbox.api.service.nhs.uk/referrals/FHIR
description: Sandbox environment.
- url: https://int.api.service.nhs.uk/referrals/FHIR
description: Integration test environment.
- url: https://api.service.nhs.uk/referrals/FHIR
description: Production environment. Not yet available.
tags:
- name: Organization
paths:
/Organization:
get:
summary: Search for an organisation
operationId: get-organization-resources
description: "## Overview\nUse this endpoint to search for organisations or sites. Site codes which are supported for certain organisations can also be accessed here, there is no separate endpoint for sites. \n\nA FHIR Organization resource will be provided for each search result.\n\nYou can search for information about an organisation using one or more of their: \n\n * ODS code \n * last change date \n * name \n * active or inactive status \n * address, city or postcode \n * organisation's primary role using RoleID, such as RO197 (NHS Trust) or RO167 (Optical Site) \n * organisation's non-primary role using RoleID, such as RO7 (Hospice) or RO318 (Integrated Care Board) \n \nThis API returns the following details for an organisation: \n\n * organisation - ODS code, name, last change date, status if active or inactive , record class (organisation or site), record use type; A complete record or a reduced record included solely for referential integrity.\n * address - house or flat number, line 1, line 2, line 3, town, postcode, Unique Property Reference Number (UPRN) and country\n * contacts - website and telephone (where available)\n * roles - primary and non-primary roles including legal and operational start and end dates \n\nYou can also request any related relations resources using the `_revinclude` parameter to return an OrganizationAffiliation Resource. \n\nYou can try out the sandbox using the 'Try this API' feature on this page. (Coming Soon!)\n\nAlternatively, you can try out the sandbox using our Postman collection (placeholder link):\n\n[](https://app.getpostman.com/run-collection/32547823-005ebee4-7510-44c3-bb0e-58f26b2ba747)\n"
parameters:
- in: query
name: _id
description: "The organisation’s ODS code. \n\nIf you already know the ODS code, use the `Get organisation details` endpoint instead.\n"
required: false
schema:
type: string
example: RR8
- in: query
name: identifier
description: "The organisation's ODS code. \n\nThis parameter is similar to `_id` but can also explicitly include the CodeSystem for the ID - which must be `ods-organization-code`. \n\nIt's included for FHIR compatibility. \n"
required: false
schema:
type: string
examples:
without-code-system:
summary: 'A search using just the ID:'
value: G81086
with-code-system:
summary: 'A search using the code system and ID:'
value: https://fhir.nhs.uk/Id/ods-organization-code|G81086
- in: query
name: lastChangeDate
description: The date that the organisation record was last modified by ODS. Supports greater than, less and equal to. Can be compounded.
required: false
schema:
type: string
examples:
greater-than:
summary: Search for changes made after a date
value: gt2017-04-01
less-than:
summary: Search for changes made before a date
value: lt2017-04-01
equal-to:
summary: Search for changes made on a single date
value: '2024-02-06'
- in: query
name: name
description: 'The start of the organisation''s name. For example, `Leeds` would match `Leeds Chest Clinic` but not `South Leeds Clinical Assessment Service`.
To search anywhere in the organisation''s name, use `name:contains`. To search for an exact match, use `name:exact`.
Not case sensitive.
Search expressions must:
- contain a minimum of 3 characters and a maximum of 100 characters
- only include the following characters: A-Z a-z 0-9 &()’+-_./:@ ''Space''
'
required: false
schema:
type: string
example: Leeds
- in: query
name: name:contains
description: 'Any part of the organisation''s name. For example, `Leeds` would match `Leeds Chest Clinic` and `South Leeds Clinical Assessment Service`.
Not case sensitive.
Search expressions must:
- contain a minimum of 3 characters and a maximum of 100 characters
- only include the following characters: A-Z a-z 0-9 &()’+-_./:@ ''Space''
'
required: false
schema:
type: string
example: Leeds
- in: query
name: name:exact
description: 'The exact organisation name.
Case sensitive.
Search expressions must:
- contain a minimum of 3 characters and a maximum of 100 characters
- only include the following characters: A-Z a-z 0-9 &()’+-_./:@ ''Space''
'
required: false
schema:
type: string
example: LEEDS TEACHING HOSPITALS NHS TRUST
- in: query
name: active
description: Whether the organisation's record is still in active use.
required: false
schema:
type: boolean
example: 'true'
- in: query
name: address-postalcode
description: 'The start of the organisation''s postcode.
To search anywhere in the postcode, use `address-postalcode:contains`. To search for an exact match, use `address-postalcode:exact`.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: LS1
- in: query
name: address-postalcode:contains
description: 'Any part of the organisation''s postcode.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: 4DZ
- in: query
name: address-postalcode:exact
description: 'The exact organisation postcode.
Case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: LS1 4DZ
- in: query
name: address-city
description: 'The start of the organisation''s city address.
To search anywhere in the city address, use `address-city:contains`. To search for an exact match, use `address-city:exact`.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: Derby
- in: query
name: address-city:contains
description: 'Any part of the organisation''s city address.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: Derby
- in: query
name: address-city:exact
description: 'The exact organisation city address.
Case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: DERBY
- in: query
name: address-country
description: 'The start of the organisation''s country.
Not case sensitive.
To search anywhere in the country address, use `address-country:contains`. To search for an exact match, use `address-country:exact`.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: ENGLAND
- in: query
name: roleCode
description: "The organisation's role, based on the `ODSOrganisationRole` CodeSystem.\n\nAn organisation in ODS can have one or many roles.\n\nTo exclude organisations with a specific role use `roleCode:not` \n\nTo search for organisations that have multiple roles (like an 'AND' operator), include the `roleCode` query parameter multiple times. \n\nTo search for organisations that have one of several roles (like an 'OR' operator), use a comma separator. \n\nYou may combine 'AND' and 'OR' searches.\n\nTo discover whether a role is primary or non-primary, refer to the `ODSOrganisationRelationship` CodeSystem \n"
required: false
schema:
type: string
examples:
without-code-system:
summary: 'A search using just the role code (RO197 = NHS trust):'
value: RO197
with-code-system:
summary: 'A search using the code system and role code:'
value: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole|RO197
multiple-roles:
summary: 'A search for multiple roles (like an ''OR'' operator):'
value: RO197,RO198
coumpound-roles:
summary: 'A search for combined roles (like an ''AND'' operator):'
value: roleCode=RO197&roleCode=RO7
- in: query
name: roleCode:not
description: "Exclude organisations from the search results based on their role \n"
required: false
schema:
type: string
examples:
compound:
summary: A search combining roleCode and roleCode:not
value: roleCode=RO177&roleCode:not=RO76
single:
summary: 'A search using the code system and role code:'
value: roleCode:not=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole|RO197
- in: query
name: activeRoleCode
description: "Searches only active roles within the `ODSOrganisationRole` CodeSystem \n\nTo exclude organisations with a specific role use `activeRoleCode:not` \nTo search for organisations that have multiple roles (like an 'AND' operator), include the `activeRoleCode` query parameter multiple times. \n\nTo search for organisations that have one of several roles (like an 'OR' operator), use a comma separator. \n\nYou may combine 'AND' and 'OR' searches.\n\nTo discover whether a role is primary or non-primary, refer to the `ODSOrganisationRelationship` CodeSystem \n"
required: false
schema:
type: string
examples:
without-code-system:
summary: 'A search using just the role code (RO197 = NHS trust):'
value: RO197
with-code-system:
summary: 'A search using the code system and role code:'
value: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole|RO197
multiple-roles:
summary: 'A search for multiple roles (like an ''OR'' operator):'
value: RO197,RO198
- in: query
name: _count
description: Number of results to return.
required: false
schema:
type: string
example: '1000'
- in: query
name: _summary
description: Return a count of the matching resources, without returning the actual matches.
required: false
schema:
type: string
enum:
- count
- in: query
name: _offset
description: When used with _count, enables paging through large result sets
required: false
schema:
type: string
example: 2000
responses:
'200':
description: Valid request that returns a FHIR Organization resource(s) that match the search criteria (which may be 0).
content:
application/fhir+json:
example:
resourceType: Bundle
id: d84a1a14-d90f-4dd7-a5bc-b5e56a81d1af
meta:
lastUpdated: '2024-03-14T11:03:31.163+00:00'
type: searchset
link:
- relation: self
url: https://jenkins.ods.dc4h.link/fhir/Organization?_count=2&lastChangeDate=lt2023-05-04&lastChangeDate=gt2023-05-02
- relation: next
url: https://jenkins.ods.dc4h.link/fhir/Organization?_count=2&_offset=2&lastChangeDate=lt2023-05-04&lastChangeDate=gt2023-05-02
entry:
- fullUrl: https://jenkins.ods.dc4h.link/fhir/Organization/AQN
resource:
resourceType: Organization
id: AQN
meta:
versionId: '3'
lastUpdated: '2024-01-23T12:56:03.130+00:00'
source: '#df0974983053aca7'
profile:
- https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
- https://fhir.nhs.uk/England/StructureDefinition/England-Organization-ODS
extension:
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole
extension:
- url: instanceID
valueInteger: 233160
- url: roleCode
valueCodeableConcept:
coding:
- system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole
code: RO172
display: INDEPENDENT SECTOR HEALTHCARE PROVIDER
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
extension:
- url: dateType
valueCoding:
system: https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
code: Legal
display: Legal
- url: period
valuePeriod:
start: '2015-04-01'
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nhs-api/refs/heads/main/openapi/nhs-api-organization-api-openapi.yml