openapi: 3.0.0
info:
version: 0.0.1
title: e-Referrals Service CodeSystem 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: CodeSystem
paths:
/CodeSystem/:
get:
summary: Search for additional instance and reference data
operationId: search-codesystem
description: "## Overview \n\nUse this endpoint to access a range of information contained in CodeSystems to meet your needs. We have CodeSystems that contain regularly changing data such as organisations, practitioners and relationships plus more traditional reference based CodeSystems.\n\nCodeSystem names include the date when they were last updated i.e. `ods-organization-code-2024-03-07` so when searching for individual concepts (records within the CodeSystem) it is necessary to perform a search using a `$lookup` providing the system and code required in addition to any properties you wish to return.\n\nFor example:\n\n`/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=G81086&property=*`\n\n### Summary information\nA summary of each codeSystem can be returned to see which properties are available and which search operations are supported, without attempting to return the data. organisation, role, relationship, postcode and geography information will all generate errors as they are too large to be returned.\n\nPerforming a search will default to summary mode and list each instance of the CodeSystem currently stored on the Server. it is expected that we will retain 2-3 versions at any given point. \n\nFor example:\n`/CodeSystem?url=https://fhir.nhs.uk/Id/ods-organization-code`\n\nThe smaller reference based CodeSystems these can be retrieved in full using `_summary=false` which will return all versions stored on the server in full.\n\n For example:\n`/CodeSystem?system=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-role&_summary=false`\n\n## Code Validation\nUsing the $validate operation you can check whether a code is present within any given ValueSet and you can also provide additional properties to validate their values.\n \nFor example:\n `CodeSystem/$validate-code?url=https://fhir.nhs.uk/Id/ods-organization-code&code=RH8&status=active`\n\n## Organisation Data\n### ods-organization-code \nhttps://fhir.nhs.uk/Id/ods-organization-code\n\nIn addition to the data available through the FHIR Organization resource we also have the following properties:\n\n * related organisations using a Relationship ID such as RE4 (commissioned by), RE6 (operated by), RE8 is Partner to and Nomonated Payee for (RE10) \n * presence of successor or predecessor information\n * indicator for onward succession\n * geographic values such as Local Authority boundary, Integrated Care Board boundary or Lower Super Output Area (LSOA) \n\n### organisation-relationship-instance \nhttps://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance \nContains relationship history\n\n### organisation-role-instance \n\nContains role history\n\n\n## Practitioner Data\n### practitioner\nhttps://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner\n\nContains the prescribing practitioner and consultants in a single CodeSystem to enable lookup and validation of Practitioner codes. Practitioners are categorised with a type and role. roles and types can be validated against the practitioner-role CodeSystem.\n\n Types include `PGP` (General Practitioner), `PNURSE` - Prescribing Nurse and `PDENTCON` Dental Consultants. \n \n Roles include `PHOSPCON120` (ear nose and throat), `PGP1` (principal GP), `PNURSE1` (district nurse / health visitor)\n\nWhere practitioners are associated to an organisation, the current/latest values is held in a membership property, these include `ME1` Parent Practice for GPs and `ME4` Parent Trust for a Dental Consultant. More information about the associations can be found in the practitioner-relationship-instance CodeSystem.\n\nThis CodeSystem has been designed to enable pracitioners with multiple codes, i.e a Prescribing Code and a General Medical Council (GMC) code to be returned or validated.\n\nProperties numbered from 1 to 8 contain a specific identifier issued by a range of authorities, more information about each assigned identifier including start date and issuing Authority can be found in the practitioner-additional-attribute CodeSystem \n\n### practitioner-relationship-instance\nhttps://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-relationship-instance\n\nContains relationship history where practitioners are associated with an organisation.\n\n### practitioner-additional-attribute\nhttps://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-additional-attribute\n\nContains additional information about the identifier issued to a practitioner, in addition to the identifier, the name and ODS code of the Issing authority, start and end dates for the identifier are included.\n\n## Geographic Data\n#### https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name\n\nSupports the identification of Office for National Statistics (ONS) identifiers for geographic boundaries used within the ods-organization-code CodeSytem. ODS identifiers for geographic organisations such as `ICB` and `Local Authority` can be retreived from the `Organization` Endpoint.\n\n#### https://digital.nhs.uk/services/organisation-data-service/CodeSystem/postcode\n\nContains every postcode within the NHS Postcode Directory and a selection of their geographic boundaries.\n\nMore information about how this data is compiled can be found in the [NHSPD user guide](https://digital.nhs.uk/binaries/content/assets/website-assets/services/ods/user_guide.pdf).\n\nthe following Geographic boundaries are included:\n * `CA` cancer alliance\n * `EW` electoral ward\n * `GOR` government office region\n * `ICB` integrated care board\n * `LA` local authority\n * `LSOA11` 2011 lower super output areas\n * `NHSER` NHS England region\n * `PC` parliamentary constituency\n * `PCO` primary care organisation \n * `SMHPC AED` strategic mental health provider collaborative - adult eating disorder\n * `SMHPC AS` strategic mental health provider collaborative - adult secure\n * `SMHPC CT4` strategic mental health provider collaborative - CYPMH tier 4\n\n## Reference Data\n#### https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole\n\nEvery organisation has at least one role; a primary role. It may also have additional roles which provide more information about the organisation's function or purpose.\n\nThe full list of role codes is contained in this CodeSystem and can be retreived in full or \nindividual role codes can be returned or validated.\n\nThis CodeSystem has 1 additional Property: `primaryRole` which contains a true/false value if the role is a primary role or not.\n\n#### https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship\n\nEvery relationship has a type to describe the nature of the relationship, which includes: `is Commissioned by`, `is operated by` and `is partner to`.\n\n#### https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner-role\n\nWithin the former CSV publications for practitioners, any classifications against a practitioner such as consultant speciality code or nurse prescriber type have been converted to roles and can be returned or validated with this CodeSystem. \n"
parameters:
- in: query
name: system
description: 'The Unique Resource Indicator (URI) of the codesystem
'
required: false
schema:
type: string
examples:
Organisation-Data:
summary: ods-organization-code
value: https://fhir.nhs.uk/Id/ods-organization-code
Relationship-Data:
summary: organization-relationship-instance
value: https://fhir.nhs.uk/Id/ods-organization-code
practitioner:
summary: practitioner
value: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/practitioner
ODSOrganisationRole:
summary: ODSOrganisationRole
value: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole
ODSRecordUseType:
summary: ODSRecordUseType
value: https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType
ODSRecordUseClass:
summary: ODSRecordClass
value: https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType
- in: query
name: code
description: "The code of the concept stored within the CodeSystem \n"
required: false
schema:
type: string
example: G7112418
- in: query
name: property
description: "Include all or specific properties from a CodeSystem. \n\nTo return all use asterisk ‘*’ \n\nTo return multiple properties, include each one as a separate parameter \n"
required: false
schema:
type: string
examples:
return-all:
summary: return all properties
value: '*'
return-one:
summary: return a single property
value: opStartDate
- in: query
name: _summmary
description: "override default behaviour to retreive a subset of the CodeSystem content when searching.\n\n `data` and `false` will generate errors on larger CodeSystems.\n"
required: false
schema:
type: boolean
example: false
responses:
'200':
description: Valid request that returns every paramter for a single concept for the specified code.
content:
application/json:
example:
resourceType: Parameters
parameter:
- name: code
valueCode: G81086
- name: display
valueString: BIRD-IN-EYE SURGERY
- name: name
valueString: ODS Organisation
- name: system
valueUri: https://fhir.nhs.uk/Id/ods-organization-code
- name: version
valueString: '2024-03-07'
- name: designation
part:
- name: use
valueCoding:
system: http://terminology.hl7.org/CodeSystem/designation-usage
code: display
- name: value
valueString: BIRD-IN-EYE SURGERY
- name: property
part:
- name: code
valueCode: status
- name: value
valueCode: active
- name: property
part:
- name: code
valueCode: RE4
- name: value
valueCode: 97R
- name: property
part:
- name: code
valueCode: RE6
- name: value
valueCode: 97R
- name: property
part:
- name: code
valueCode: RE8
- name: value
valueCode: U36842
- name: property
part:
- name: code
valueCode: inactive
- name: value
valueBoolean: false
- name: valueBoolean
valueBoolean: false
- name: property
part:
- name: code
valueCode: country
- name: valueString
valueString: ENGLAND
- name: value
valueString: ENGLAND
- name: property
part:
- name: code
valueCode: opStartDate
- name: valueDateTime
valueDateTime: '1974-04-01'
- name: value
valueDateTime: '1974-04-01'
- name: property
part:
- name: code
valueCode: SMHPC CT4
- name: valueCoding
valueCoding:
system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name
code: B0N9F
- name: value
valueCoding:
system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name
code: B0N9F
- name: property
part:
- name: code
valueCode: LSOA11
- name: valueCoding
valueCoding:
system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name
code: E01021221
- name: value
valueCoding:
system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name
code: E01021221
- name: property
part:
- name: code
valueCode: uprn
- name: valueString
valueString: '10091054340'
- name: value
valueString: '10091054340'
- name: property
part:
- name: code
valueCode: town
- name: valueString
valueString: UCKFIELD
- name: value
valueString: UCKFIELD
- name: property
part:
- name: code
valueCode: postcode
- name: valueString
valueString: TN22 5AW
- name: value
valueString: TN22 5AW
- name: property
part:
- name: code
valueCode: telephone
- name: valueString
valueString: 01825 763196
- name: value
valueString: 01825 763196
- name: property
part:
- name: code
valueCode: NHSER
- name: valueCoding
valueCoding:
system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/geography-name
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nhs-api/refs/heads/main/openapi/nhs-api-codesystem-api-openapi.yml