e-referrals-service-api.yaml

# This is an OpenAPI Specification (https://swagger.io/specification/)
# for the e-Referral Service API
# owned by NHS Digital (https://digital.nhs.uk/)
openapi: 3.0.0
x-nhsd-api-platform:
  meta:
    service_name: e-referrals-service-api
    short_service_name: ers
    service_base_path: referrals
    product_display_name: e-Referrals-Service
    product_description: 'The NHS e-RS vision is to enable local innovation and adoption of paperless referrals. To support this vision NHS Digital have created a set of APIs which provide a well-defined, simple to use data interface to the NHS e-Referral Service (e-RS). See https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir'
    pipeline_name_prefix: E-Referrals-Service
info:
  version: 0.0.1
  title: e-Referrals Service
  description: |
    ## Overview
    Use 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).

    **As a primary care referrer, you can:**

      -	create a new e-referral
      - search for relevant patient services to create a shortlist
      -	access existing e-referrals
      -	create a triage request for the Referral Assessment Service (RAS)
      -	upload and manage a patient letter or attachments, linking them to a referral
      -	retrieve appointment slots and book appointments
      -	defer a booking to a provider if an appointment slot is unavailable
      - create a new advice and guidance request

    **As a secondary care provider, you can:**

      -	access referrals as a worklist
      -	retrieve non-clinical information (meta-data) about the referral
      -	retrieve attachments which are linked to a referral or triage (RAS) request
      -	retrieve clinical information which has been provided by a referrer
      -	accept or reject a referral request
      -	retrieve Advice & Guidance (A&G) conversations and send responses
      -	convert Advice & Guidance (A&G) conversations into a referral

    **You cannot use this API to:**

      -	get patient details - instead, use the [[HYPERLINK_PDS]]

    **You can access the following data:**

      -	referral attachments
      -	referral letters
      -	appointment slots
      -	worklists for referral requests
      -	worklists for triage (RAS) requests
      -	worklists for Advice and Guidance (A&G) requests
      -	conversation histories for Advice and Guidance (A&G) requests


    ### Access modes
    
    This API has two access modes:

    | Access mode                   | Authentication via    | Functions               | Availability                    |
    | ----------------------------- | -------------------------- | ----------------------- | ------------------------------- |
    | Application-restricted,<br/>unattended access | [[HYPERLINK_SIGNED_JWT]]   | <ul><li>[[HYPERLINK_A004]]</li><li>[[HYPERLINK_A005]]</li><li>[[HYPERLINK_A006]]</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_A037]]</li><li>[[HYPERLINK_A043]]</li></ul> | [[HYPERLINK_PRODUCTION]] |
    | Healthcare worker,<br/>user-restricted access | [[HYPERLINK_CIS_AUTH_SHORT]]  | All Endpoints | [[HYPERLINK_PRODUCTION]] |

    ##### Application-restricted, unattended access

    This 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.
    Application-restricted, unattended access should only be used when authenticating a human user (for example via smartcard) is not possible.

    Write operations are currently supported for specific use cases via:
    - [[HYPERLINK_A028]]
    - [[HYPERLINK_A013]]

    You will be required to submit your use case for review when using this endpoint via application-restricted, unattended access.

    ##### Healthcare worker, user-restricted access

    This access mode allows Partner applications to access e-RS FHIR API endpoints by authenticating users with [[HYPERLINK_CIS_AUTH_LONG]].
    
    This access mode must be used for writing changes (such as Create Referral).

    ## Who can use this API

    You 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. 

    To use this API:

      -	you must have justification for doing so
      -	you must register with the [e-RS Partners Service](https://developer-test.nhs.uk/apis/e-Referrals/getstarted_partner_registration.html)
      -	as an e-RS Partner, we offer you guidance and support for onboarding via the e-RS Partners Service which can be contacted via emailing [nhserspartners@nhs.net](mailto:nhserspartners@nhs.net)
      -	you must [assure](https://developer.nhs.uk/apis/e-Referrals/assure_compliance_approach.html) your solution before we grant access to live data
      -	clinical safety remains your responsibility (and the responsibility of your end user organisations), as laid out in the NHS e-RS Integration API [compliance approach](https://developer.nhs.uk/apis/e-Referrals/assure_compliance_approach.html)

    See the [[HYPERLINK_ONBOARDING]] section below for more information.

    <section class="nhsd-m-emphasis-box nhsd-m-emphasis-box--important nhsd-!t-margin-bottom-6" aria-label="Important Information">
        <div class="nhsd-a-box nhsd-a-box--border-yellow">                <div class="nhsd-m-emphasis-box__image-box">
                    <figure class="nhsd-a-image">
                        <picture class="nhsd-a-image__picture">
                                    <img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNS4xLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT48c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIGlkPSJMYXllcl8xIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCAxNDAgMTQwOyIgdmVyc2lvbj0iMS4xIiB2aWV3Qm94PSIwIDAgMTQwIDE0MCIgeD0iMHB4IiB4bWw6c3BhY2U9InByZXNlcnZlIiB5PSIwcHgiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtkaXNwbGF5Om5vbmU7fQoJLnN0MXtkaXNwbGF5OmlubGluZTtmaWxsOiMyMzFmMjA7fQoJLnN0MntmaWxsOiMyMzFmMjA7fQoJLnN0M3tmaWxsOm5vbmU7c3Ryb2tlOiMyMzFmMjA7c3Ryb2tlLXdpZHRoOjEuOTI7c3Ryb2tlLWxpbmVjYXA6cm91bmQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjEwO30KCS5zdDR7ZmlsbDojMjMxZjIwO30KCS5zdDV7ZmlsbDojMjMxZjIwO30KCS5zdDZ7ZmlsbDpub25lO3N0cm9rZTojMjMxZjIwO3N0cm9rZS13aWR0aDo1O3N0cm9rZS1taXRlcmxpbWl0OjEwO30KPC9zdHlsZT4KPGcgY2xhc3M9InN0MCI+Cgk8cGF0aCBjbGFzcz0ic3QxIiBkPSJNNzAsNi45NWw1NCwzMS41djYzLjExbC01NCwzMS41bC01NC0zMS41VjM4LjQ1TDcwLDYuOTUgTTcwLDBMMTAsMzV2NzBsNjAsMzVsNjAtMzVWMzVMNzAsMEw3MCwweiIvPgo8L2c+CjxnPgoJPHBhdGggY2xhc3M9InN0MiIgZD0iTTEwOS44NiwzOS44NXY1NUg4NS43Yy0zLjA2LDAtNS4xNCwzLjA2LTcuMDgsNWgtMTcuNWMtMS45NC0xLjk0LTQuMDMtNS03LjA4LTVIMjkuODd2LTU1aDI1ICAgYzUuMjgsMCwxMC44MywxLjMyLDE1LDQuNzljNC4xNy0zLjQ3LDkuNzItNC43OSwxNS00Ljc5SDEwOS44NnogTTY0Ljg2LDU0Ljg1YzAtMy44OS03LjIyLTUtMTAtNWgtMTV2MzVoMTMuNzUgICBjNS42MiwwLDcuNTcsMC42OSwxMS4yNSw1VjU0Ljg1eiBNOTkuODYsNDkuODVoLTE1Yy0yLjc4LDAtMTAsMS4xMS0xMCw1djM1YzMuNjgtNC4zMSw1LjYyLTUsMTEuMjUtNWgxMy43NVY0OS44NXoiLz4KPC9nPgo8L3N2Zz4K" alt="" style="object-fit:fill">
                        </picture>
                    </figure>
                </div>            <div class="nhsd-m-emphasis-box__content-box">
                    <div data-uipath="website.contentblock.emphasis.content" class="nhsd-t-word-break"><p class="nhsd-t-body">For a non-technical overview of how to build software that deals with referrals and bookings, see&nbsp;<a onclick="logGoogleAnalyticsEvent('Link click','General','/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings');" href="https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings" onkeyup="return vjsu.onKeyUp(event)" class="nhsd-a-link">Building healthcare software - referrals and bookings</a>.</p></div>            </div>
        </div>
    </section>

    ## Related APIs

    [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). 


    ## API status and roadmap

    ### Application-restricted, unattended access

    This access mode is [[HYPERLINK_PRODUCTION]]. We are onboarding Partners to use it.

    Please note that it can only be used:

    - when authenticating a human user is not possible
    - by 'Provider Organisations' or 'Referrer Organisations'
    - for accessing endpoints 
      - [[HYPERLINK_A004]]
      - [[HYPERLINK_A005]]
      - [[HYPERLINK_A006]]
      - [[HYPERLINK_A007]]
      - [[HYPERLINK_A008]]
      - [[HYPERLINK_A013]]
      - [[HYPERLINK_A024]]
      - [[HYPERLINK_A025]]
      - [[HYPERLINK_A028]]
      - [[HYPERLINK_A029]]
      - [[HYPERLINK_A033]]
      - [[HYPERLINK_A035]]
      - [[HYPERLINK_A037]]
      - [[HYPERLINK_A043]]

    For more information, please see [[HYPERLINK_NETWORK_ACCESS]].

    ### Healthcare worker, user-restricted access

    This access mode is [[HYPERLINK_PRODUCTION]]. We are onboarding Partners to use it.
    
    This access mode allows you to use all endpoints. A human user must be present and authenticated.
    
    For more information, please see [[HYPERLINK_NETWORK_ACCESS]].

    ### Roadmap

    For the current e-RS roadmap see [the future of the NHS e-referral service](https://digital.nhs.uk/services/e-referral-service/the-future-of-the-nhs-e-referral-service#future-service-roadmap).
    
    ## Service level
    This API is a gold service, meaning it is operational and supported 24 hours a day, 365 days a year.

    For more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).

    ## Technology

    This API is primarily [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#basic-rest) 
    and based on [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir) global standards for health care data exchange.

    This API supports FHIR STU3 and FHIR R4.

    ### FHIR STU3

    The e-RS FHIR STU3 API is built against the set of profiles called [CareConnect](https://nhsconnect.github.io/CareConnectAPI/).

    ### FHIR R4

    The 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).

    ## Network access

    This 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).

    To use this API with NHS smartcards you do need an HSCN connection, although internet-facing alternatives are available.

    For more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).


    ## Security and authorisation

    ### Application-restricted, unattended access

    This 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.
    
    You can only use this access mode when authenticating a human user (for example via smartcard) is not possible.
    
    To use this access mode, use the following security pattern:
    - [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)

    ###  Healthcare worker, user-restricted access

    This 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.

    The end user must be:
    - present
    - a healthcare worker
    - strongly authenticated and authorised by [[HYPERLINK_CIS_AUTH_LONG]]

    In order to successfully authenticate with CIS2, the NHS e-Referral Service requires end users to be authenticated to the following standards:
      - 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
      - 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

    To use this access mode, use one of the following security patterns:
    - [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)
    - [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)
    
    #### Role and Organisation Validation
    For 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. 

    The e-RS Role is supplied to the endpoint via the `NHSD-eRS-Business-Function` request header. 
    
    The Organisation is supplied to the endpoint via the `NHSD-End-User-Organisation-ODS` request header. 
    
    Suitable values for these request headers can be obtained from the Practitioner Role Bundle returned by [[HYPERLINK_A030]].

    #### On Behalf Of User
    If 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.

    "On behalf of" is only supported for a Service Provider Clinician Admin (SPCA) acting on behalf of a Service Provider Clinician (SPC).

    ## Environments and testing

    | Environment       | Base URL                                                               |
    | ----------------- | ---------------------------------------------------------------------- |
    | Sandbox           | `https://sandbox.api.service.nhs.uk/referrals/FHIR` |
    | Alpha             | See Alpha testing section below |
    | Integration test  | `https://int.api.service.nhs.uk/referrals/FHIR` |
    | Production        | `https://api.service.nhs.uk/referrals/FHIR` |

    ### Sandbox testing

    Our [sandbox](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing) environment:
    -	is for developer education and early testing
    -	only covers a limited set of scenarios
    -	is stateless, so does not actually persist any updates
    -	is open access, so does not allow you to test authorisation

    Try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.

    The sandbox will only respond to an input which exactly matches one of the examples provided; it is otherwise stateless.

    ### Alpha testing

    Our [alpha](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses) environment:
    -	is available for early developer testing of future functionality  
    -	may experience breaking changes or downtime without advance notice, but only if we cannot avoid it
    - can be accessed by contacting [nhserspartners@nhs.net](mailto:nhserspartners@nhs.net)

    ### Integration testing

    Our [integration test](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis) environment:
      -	is where the majority of your integration efforts will take place
      - is where we conduct witness testing for your application
      -	is stateful, so data will be persisted


    ## Onboarding

    You need to get your software approved by us before it can go live. We call this process onboarding. 

    Onboarding essentially involves connecting to the e-RS FHIR API Integration (INT) environment, assuring your solution and going live, in accordance with the [Supplier Conformance Assessment List (SCAL) process](https://digital.nhs.uk/developer/guides-and-documentation/onboarding-process#onboard-using-the-supplier-conformance-assessment-list-scal-process). 
   
    In order to pass through the onboarding process as efficiently as possible, it is worth planning ahead. 
    
    When following the general SCAL process, please note:
    
    In step 1: to use this API, you need to register with [nhserspartners@nhs.net](mailto:nhserspartners@nhs.net) using [Partner Registration](https://developer.nhs.uk/apis/e-Referrals/getstarted_partner_registration.html) and discuss your use case with us. You must also register with the API Management team via [https://digital.nhs.uk/developer/getting-started](https://digital.nhs.uk/developer/getting-started) to configure your application. 
   
    In step 2: to request a SCAL, please ensure you have discussed your solution with the Partners service via [nhserspartners@nhs.net](mailto:nhserspartners@nhs.net), who will put you in touch with [ersapi.assurance@nhs.net](mailto:ersapi.assurance@nhs.net) who are responsible for assurance of solutions that integrate with the e-RS FHIR API.
   
    In step 8: to organise witness testing of your solution, please liaise with [ersapi.assurance@nhs.net](mailto:ersapi.assurance@nhs.net).
    
    In step 11: when submitting your SCAL for review, please liaise with [ersapi.assurance@nhs.net](mailto:ersapi.assurance@nhs.net).
    
    In step 12: to obtain a Connection Agreement, please liaise with [liveserviceonboarding@nhs.net](mailto:liveserviceonboarding@nhs.net). You will need to have successfully passed witness testing with [ersapi.assurance@nhs.net](mailto:ersapi.assurance@nhs.net) and obtained a Technical Conformance Certificate (TCC).
    
    In step 13: to obtain the End User Organisation Acceptable Use Policy (EUOAUP), please liaise with [liveserviceonboarding@nhs.net](mailto:liveserviceonboarding@nhs.net).
    
    In step 14: following receipt, review and acceptance of your signed Connection Agreement, the e-RS FHIR API Partners team will contact you to facilitate production access for your application.
    
    ## Errors
    We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
    * 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
    * 400 to 499 if it failed because of a client error by your application
    * 500 to 599 if it failed because of an error on our server
    
    Errors 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.
    

  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: Retrieve user information
  - name: Refer patient
  - name: Arrange appointment
  - name: Arrange triage
  - name: Request advice
  - name: Retrieve healthcare service information
  - name: Change appointment
  - name: Manage referral
  - name: Retrieve clinical information
  - name: Review referral requests
  - name: Review advice and guidance requests
    
paths:
  /STU3/CodeSystem/{codeSystemType}:
    get:
      $ref: 'components/stu3/schemas/endpoints/a004-retrieve-reference-data.yaml'
  /STU3/ReferralRequest/$ers.fetchworklist:
    post:
      $ref: 'components/stu3/schemas/endpoints/a008-retrieve-worklist.yaml'
  /STU3/ReferralRequest/{ubrn}:
    get:
      $ref: 'components/stu3/schemas/endpoints/a005-retrieve-referral-request.yaml'
  /STU3/Task:
    get:
      $ref: 'components/stu3/schemas/endpoints/a029-available-actions-for-user-list.yaml'
  /STU3/ReferralRequest/{ubrn}/_history/{version}:
    get:
      $ref: 'components/stu3/schemas/endpoints/a005-retrieve-referral-request-versioned.yaml'
  /STU3/Binary/{attachmentLogicalID}:
    get:
      $ref: 'components/stu3/schemas/endpoints/a006-retrieve-attachment.yaml'
  /R4/Binary/{id}:
    get:
      $ref: 'components/r4/schemas/endpoints/a042-retrieve-attachment.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.generateCRI:
    post:
      $ref: 'components/stu3/schemas/endpoints/a007-retrieve-clinical-information.yaml'
  /STU3/HealthcareService/$ers.searchHealthcareServicesForPatient:
    post:
      $ref: 'components/stu3/schemas/endpoints/a010-patient-service-search.yaml'
  /STU3/ReferralRequest/$ers.createReferral:
    post:
      $ref: 'components/stu3/schemas/endpoints/a011-create-referral.yaml'
  /STU3/ReferralRequest/$ers.createReferralAndSendForTriage:
    post:
      $ref: 'components/stu3/schemas/endpoints/a021-create-referral-request-and-send-for-triage.yaml'
  /STU3/Slot:
    get:
      $ref: 'components/stu3/schemas/endpoints/a015-retrieve-appointment-slots.yaml'
  /STU3/Appointment:
    post:
      $ref: 'components/stu3/schemas/endpoints/a016-book-or-defer-appointment.yaml'
  /STU3/Binary:
    post:
      $ref: 'components/stu3/schemas/endpoints/a020-upload-file-to-document-store.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.maintainReferralLetter:
    post:
      $ref: 'components/stu3/schemas/endpoints/a012-maintain-referral-letter.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.acceptReferral:
    post:
      $ref: 'components/stu3/schemas/endpoints/a013-accept-referral.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.rejectReferral:
    post:
      $ref: 'components/stu3/schemas/endpoints/a014-reject-referral.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.generatePatientLetter:
    post:
      $ref: 'components/stu3/schemas/endpoints/a019-generate-patient-letter.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.cancelAppointmentActionLater:
    post:
      $ref: 'components/stu3/schemas/endpoints/a022-cancel-appointment-action-later.yaml'
  /STU3/CommunicationRequest/$ers.fetchworklist:
    post:
      $ref: 'components/stu3/schemas/endpoints/a023-retrieve-a&g-worklist.yaml'
  /STU3/CommunicationRequest/{ubrn}:
    get:
      $ref: 'components/stu3/schemas/endpoints/a024-retrieve-advice-and-guidance.yaml'
  /STU3/CommunicationRequest/{ubrn}/_history/{version}:
    get:
      $ref: 'components/stu3/schemas/endpoints/a024-retrieve-advice-and-guidance-versioned.yaml'
  /STU3/Communication:
    get:
      $ref: 'components/stu3/schemas/endpoints/a025-retrieve-advice-and-guidance-conversation.yaml'
  /STU3/CommunicationRequest/{ubrn}/$ers.sendCommunicationToRequester:
    post:
      $ref: 'components/stu3/schemas/endpoints/a026-send-a&g-response.yaml'
  /STU3/ReferralRequest/$ers.createFromCommunicationRequestActionLater:
    post:
      $ref: 'components/stu3/schemas/endpoints/a027-convert-a&g-to-referral.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.recordReviewOutcome:
    post:
      $ref: 'components/stu3/schemas/endpoints/a028-record-triage-outcome.yaml'
  /R4/PractitionerRole:
    get:
      $ref: 'components/r4/schemas/endpoints/a030-retrieve-business-functions.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.changeShortlist:
    post:
      $ref: 'components/stu3/schemas/endpoints/a031-change-shortlist.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.changeShortlistAndSendForTriage:
    post:
      $ref: 'components/stu3/schemas/endpoints/a032-change-shortlist-and-send-for-triage.yaml'
  /R4/HealthcareService/{id}:
    get:
      $ref: 'components/r4/schemas/endpoints/a033-retrieve-healthcare-service.yaml'
    head:
      $ref: 'components/r4/schemas/endpoints/a037-retrieve-healthcare-service-version.yaml'
  /STU3/Appointment/{id}:
    put:
      $ref: 'components/stu3/schemas/endpoints/a034-update-appointment.yaml'
    get:
      $ref: 'components/stu3/schemas/endpoints/a038-retrieve-appointment.yaml'
  /STU3/Appointment/{id}/_history/{version}:
    get:
      $ref: 'components/stu3/schemas/endpoints/a038-retrieve-appointment-versioned.yaml'
  /R4/HealthcareService:
    get:
      $ref: 'components/r4/schemas/endpoints/a035-search-for-healthcare-services.yaml'
  /STU3/ReferralRequest/{ubrn}/$ers.cancelReferral:
    post:
      $ref: 'components/stu3/schemas/endpoints/a036-cancel-referral.yaml'
  /R4/Practitioner:
    get:
      $ref: 'components/r4/schemas/endpoints/a040-retrieve-practitioner-info.yaml'
  /STU3/CommunicationRequest/{ubrn}/$ers.generateCRI:
    post:
      $ref: 'components/stu3/schemas/endpoints/a043-retrieve-advice-and-guidance-overview-pdf.yaml'
  /STU3/CommunicationRequest/$ers.createAdviceAndGuidance:
    post:
      $ref: 'components/stu3/schemas/endpoints/a044-create-advice-and-guidance-request.yaml'
  /R4/ServiceRequest:
    get:
      $ref: 'components/r4/schemas/endpoints/a041-search-service-request.yaml'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT