Skip to main content
The Website Services team at NHS England are testing early designs to understand how you find information. Your views will help us check our ideas work. Sign up to take part in our user research.

Relationships endpoint

This page includes the relationships endpoint description, parameters and examples.

https://directory.spineservices.nhs.uk/ORD/2-0-0/rels/<RelId>?{parameters}
https://directory.spineservices.nhs.uk/ORD/2-0-0/rels?{parameters}


Description

Retrieve CodeSystems information for Relationships meta data.


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 descriptive content is displayed.


Example

To retrieve details about a specific RelId use the following query:

https://directory.spineservices.nhs.uk/ORD/2-0-0/rels/RE4

{"Relationships": [{"id": "RE4", "code": "4", "displayName": "IS COMMISSIONED BY"}]}

To return an XML representation:

https://directory.spineservices.nhs.uk/ORD/2-0-0/rels/RE4?_format=xml

<?xml version="1.0"?>
<CodeSystem oid="2.16.840.1.113883.2.1.3.2.4.17.508" name="OrganisationRelationship">
<Relationships>
<Relationship>
<id>RE4</id>
<code>4</code>
<displayName>IS COMMISSIONED BY</displayName>
</Relationship>
</Relationships>
</CodeSystem>


Use the following query retrieve information relating to all Relationships.

https://directory.spineservices.nhs.uk/ORD/2-0-0/rels

{"Relationships": [{"id": "RE2", "code": "2", "displayName": "IS A SUB-DIVISION OF"}, {"id": "RE4", "code": "4", "displayName": "IS COMMISSIONED BY"}, {"id": "RE6", "code": "6", "displayName": "IS OPERATED BY"}, {"id": "RE5", "code": "5", "displayName": "IS LOCATED IN THE GEOGRAPHY OF"}, {"id": "RE3", "code": "3", "displayName": "IS DIRECTED BY"}]}

To return an XML representation:

<?xml version="1.0"?>
<CodeSystem oid="2.16.840.1.113883.2.1.3.2.4.17.508" name="OrganisationRelationship">
<Relationships>
<Relationship>
<id>RE2</id>
<code>2</code>
<displayName>IS A SUB-DIVISION OF</displayName>
</Relationship>
<Relationship>
<id>RE4</id>
<code>4</code>
<displayName>IS COMMISSIONED BY</displayName>
</Relationship>
<Relationship>
<id>RE6</id>
<code>6</code>
<displayName>IS OPERATED BY</displayName>
</Relationship>
<Relationship>
<id>RE5</id>
<code>5</code>
<displayName>IS LOCATED IN THE GEOGRAPHY OF</displayName>
</Relationship>
<Relationship>
<id>RE3</id>
<code>3</code>
<displayName>IS DIRECTED BY</displayName>
</Relationship>
</Relationships>
</CodeSystem>

Last edited: 23 August 2019 2:46 pm