https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations?{search parameters}
Endpoint
Description
Search the ODS database based on several parameters and return a summary of multiple organisations. The parameters can be used independently or as part of a search combination to help with reducing the number of search results returned. The below outlines the search parameter syntax used with some basic examples provided.
Parameters
| Parameter | Description |
_format |
String - case sensitive Can take xml, json, text/json, text/xml, application/json and application/xml as arguments. If this parameter is not supplied, the format will default to JSON. Note that _format specifies the format in which summary information is displayed and also the links to individual records. If _format=xml is specified in the search term then the OrgLink entries will have the argument ?_format=xml appended to link the individual records. |
Name |
string - not case sensitive Search for organisations based on name. Organisations that contain the argument string in their name are returned. |
PostCode |
string - not case sensitive Search for organisations based on postcode. Organisations that contain the argument string in their postcode are returned. |
LastChangeDate |
Date Search for organisations based on their last changed date. Date must be in format YYYY-MM-DD. The search is greater than or equal to. Dates are restricted to 185 days from present. |
Status |
string - not case sensitive Search for organisations based on their active status. Arguments can be Active or Inactive. |
PrimaryRoleId |
string - not case sensitive Search for organisations based on their primary role codes. A role code must be passed through as an argument. The Roles endpoint allows consumers to query the Code Systems meta data relating to roles – read our guidance on the Roles endpoint. |
NonPrimaryRoleId |
string - not case sensitive Search for organisations based on their non primary role codes. A role code must be passed through as an argument. The Roles endpoint allows consumers to query the Code Systems meta data relating to roles – see guidance on the Roles endpoint. |
OrgRecordClass |
string - not case sensitive Search for organisations based on their record class. |
Limit |
integer Used to limit the number of organisations returned by response. The argument can range from 1 to 1,000. |
Offset |
integer |
Membership search
The membership search function allows consumers to retrieve records related to a given organisation. Within the ODS data, relationships exist between source records and target organisations. The relationships are uni-directional and are held within the record on the source organisation, such as where a source record is a Trust site its target would generally be a Trust, and the relationship would be represented as RE6 (IS OPERATED BY). The membership search allows all source records related to the Trust be returned.
The membership search takes the following parameters:
RelTypeId |
List of 1 or more Relationship Type IDs (required) The Relationships endpoint allows consumers to query the Code Systems meta data relating to Relationship Types – see guidance on the Relationships endpoint. Information regarding the Relationship Types which can exist between source and target Primary Roles is available in the XMLRelationshipRules spreadsheet within the XML support products section of the XML Organisations Data Products page. |
TargetOrgId |
String (required). This is the Target organisation to which the required records are related, e.g. passing in the ODS code for a CCG code would return all Prescribing Cost Centres. |
RelStatus |
String (optional). RelStatus allows returned records to be filtered based on whether the relationship between the Source organisations and the Target Organisation are Active (i.e. the end date of the relationship is not present in the source record). Allowed values are: ALL – returns every relationship, active and inactive. active – returns the Source records where the relationship to the Target Organisation is active. inactive - returns the Source records where the relationship to the Target Organisation is inactive. If the RelStatus parameter is omitted it is interpreted as active. |
The parameters above can be passed to the search in any order; however the logic will be applied as:
return any records which have a relationship of a given type (or types) to this Target organisation [with a RelStatus of….].
The Limit, _format and Offset parameters can also be combined within the Membership Search Query.
Example
To retrieve a subset of source records (using Limit and Offset) which have active relationships to a Target organisation (the CCG 99A in this case) use the following query:
All records returned align to the existing Summary Format, described further down on this page.
Note that the Active Status contained in the Summary Record data should not be confused with the RelStatus passed to the Search itself. It is the Status of any relationship within the scope of the query that is being processed and not the Status of the Source or Target records.
Summary Record Format
The following shows the attributes returned in a summary record format:
https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations?Name=ABES
JSON
Example
The following query returns summary information for one or more organisations where the Name attribute passed in is a substring of the organisation’s name (in this example the organisation name contains ‘Blackdown’.
https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations?Name=Blackdown
Find examples on the parameters page.
JSON
Last edited: 23 August 2019 1:50 pm