Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Display Order of Returned Services

Details about the CheckCapacitySummary order of included services

Calculate Display Order of Returned Services

If fewer than two services remain after the filtering processes, the Catch-all search is invoked. This is described separately. It two or more services remain, these are ranked and ordered so that they are displayed in the most appropriate order. This is determined by the CCG that commissions the services and is known as the Ranking Strategy.

Check Ranking Strategy

Each CCG service in the DoS is linked to a CCG organisation, against which the ranking strategies are stored, as it is the CCGs who determine their preferred order in which patients are referred to services. Ranking order is assigned to service types and not to individual services. The DoS holds a list of each CCG and the postcodes for which they are responsible. The postcode in the request is matched against this list and, if a match is found, the ranking strategy for that CCG is used. The postcode to CCG list is updated quarterly on release of updated files from the Organisation Data Service (ODS). The following rules are in place:

  • If the search postcode can be matched to a CCG Organisation, use the ranking strategy of that CCG
  • If the search postcode cannot be matched to a CCG Organisation, use the national ranking

Place Services in Order According to Rank

This step uses the rank assigned to each service type – this is a number from 1-5, with 1 being the highest – and places the services in ranking order. The following rules are in place:

  • Service Types with a higher rank are placed above those of a lower rank
  • Where there are Service Types included in the results which have the same rank, services are ordered within the ranking column based on the distance from patient value

Place Services in Order According to CCG

This step checks whether a service has been promoted to a particular CCG. If any services are promoted to a CCG other than that of the search location, they will return below those that either are not promoted or are promoted to the CCG of the search location. Each group is still ordered according to the service type ranking described above.

Place Services in Order According to Service Referral

Once services have been placed in order according to their rank, a further sort is carried out which orders each service within its given ranking level. In addition, a label of (Home) is suffixed to the service name where appropriate. This takes into account the following information:

  • Whether the service is the patient’s home GP. This is determined by the fact that the ODS code of the service matches that used in the request. Where no ODS code is used in the request, neither the home GP nor the home Out of Hours GP will be recognised as such.
  • Whether the service is the patient’s home Out of Hours GP provider. If the service has the service type of ‘GP Out of Hours Provider (OOH)’ and is linked as a commissioned service (using the Service Referral section on the Clinical Details tab) to the patient’s home GP, then a label of (Home OOH) is added to the name. This does not affect the ordering for this service.
  • Whether or not the service is commissioned by the patient’s home GP, as these are ranked higher than those which are not. When determining the order of services within each ranking level, the following rules are used. Note that the distance ordering applied in the earlier step is retained:
  • Within each ranking level (e.g. highest, high etc), place services in order:
    1. Surgery (home GP)
    2. Commissioned Services (restricted)
    3. Commissioned Services (unrestricted)
    4. All others

Remove Surplus Results

Once the services have been sorted according to the rules above, only the top two services for each service type is retained.

Return Results

The web service response returns all the remaining services, in the correct order, including the distance from patient value. The exact display of results is determined by the provider system, but they must be displayed in the given order.


All content is available under the Open Government Licence v3.0, except where otherwise stated