1. Read
Returns a single Organization for the specified id.
By default the response will be returned in JSON, however XML is also supported.
1.1. Response
A full set of response codes can be found here API Response Codes. FHIR Servers SHALL support the following response codes:
| 200 | OK |
| 404 | Not Found |
| 500 | Internal Server Error |
2. Search
Returns a Bundle of all Organization resources that match the specified search criteria.
By default the response will be returned in JSON, however XML is also supported.
2.1. Search Parameters
The search parameters supported in the API for the Organization resource are in the table below. The parameters can be used independently or in combination to help refine the search results returned. This section outlines the search parameter syntax used, with some examples provided.
| Name | Parameter Type | Description | Path |
|---|---|---|---|
_id |
token |
The logical id of the resource (Code) | Organization.id |
_lastUpdated |
date |
To select resources based on the last time they were changed | Organization.meta.lastUpdated |
Additional Parameters:
| Name | Parameter Type | Description | Allowable Content |
|---|---|---|---|
_count |
number |
Number of results per page | Whole number |
_summary |
string |
Search only: just return a count of the matching resources, without returning the actual matches | ‘count’ |
2.1.1. _id
See _id for details on this parameter.
GET https://directory.spineservices.nhs.uk/STU3/Organization?_id=RTG
Return Organization resource where Code logical id matches RTG (Derby Teaching Hospitals NHS Foundation Trust).2.1.2. _lastUpdated
See _lastUpdated for details on this parameter.
GET https://directory.spineservices.nhs.uk/STU3/Organization?_lastUpdated=gt2017-04-01
Return all Organization resources where the Organization record was updated after 2017-04-01.The supported prefixes for this search parameter are:
| Prefix | Description |
|---|---|
| gt | greater than |
2.1.3. identifier
GET https://directory.spineservices.nhs.uk/STU3/Organization?identifier=[code]
See token for details on this parameter.
GET https://directory.spineservices.nhs.uk/STU3/Organization?identifier=https://fhir.nhs.uk/Id/code|RTG
Return the Organization resource with Code of RTG (Derby Teaching Hospitals NHS Foundation Trust).GET https://directory.spineservices.nhs.uk/STU3/Organization?identifier=RTG
Return the Organization resource with Code of RTG (Derby Teaching Hospitals NHS Foundation Trust).2.1.4. name
See string for details on this parameter.
GET https://directory.spineservices.nhs.uk/STU3/Organization?name=Derby Teaching Hospitals NHS Foundation Trust
Return all Organization resources with name of Derby Teaching Hospitals NHS Foundation Trust.Search expressions must:
- Contain a minimum of 3 characters and a maximum of 100 characters
- Only include characters (A-Z a-z 0-9 &()’+ -_ -./ : : @) ‘Space’
Begins with:
By default, a field matches a string query if the value of the field equals or starts with the supplied parameter value, after both have been normalized by case and accent.
To search for a name that begins with “Leeds”, the following search should be executed:
GET https://directory.spineservices.nhs.uk/STU3/Organization?name=Leeds
This will return the records that have an Organization name that begins with “Leeds” e.g. RQS98 - Leeds Chest Clinic and RX847 - Leeds Central Ambulance Station etc.
Contained match:
The :contains modifier returns results that include the supplied parameter value anywhere within the field being searched.
To search for a name that contains “Leeds”, the following search should be executed:
GET https://directory.spineservices.nhs.uk/STU3/Organization?name:contains=Leeds
This will return the records that have an Organization name that contains the word “Leeds” within its name e.g 5HL18 - South Leeds Clinical Assessment Service and B86013 - The North Leeds Medical Practice etc.