Organisation endpoint
Developer information for organisation endpoint.
Endpoint
https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/<ods_code>?
Description
Return the full organisational data of a single organisation via ODS code.
Parameters
| Parameter | Description |
| _format |
string |
Example
Use the following query to search for a specified organisation code (X26 in this example), and return the full data for the organisation specified:
https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/X26
{
"Organisation": {
"Name": "NHS DIGITAL",
"Date": [
{
"Type": "Operational",
"Start": "2013-01-21"
},
{
"Type": "Legal",
"Start": "2013-04-01"
}
],
"OrgId": {
"root": "2.16.840.1.113883.2.1.3.2.4.18.48",
"assigningAuthorityName": "HSCIC",
"extension": "X26"
},
"Status": "Active",
"LastChangeDate": "2016-09-09",
"orgRecordClass": "RC1",
"GeoLoc": {
"Location": {
"AddrLn1": "1 TREVELYAN SQUARE",
"AddrLn2": "BOAR LANE",
"PostCode": "LS1 6AE",
"Town": "LEEDS",
"County": "WEST YORKSHIRE",
"Country": "ENGLAND"
}
},
"Roles": {
"Role": [
{
"id": "RO116",
"uniqueRoleId": 166234,
"primaryRole": true,
"Status": "Active",
"Date": [
{
"Type": "Operational",
"Start": "2013-01-21"
},
{
"Type": "Legal",
"Start": "2013-04-01"
}
]
}
]
},
"Rels": {
"Rel": [
{
"Date": [
{
"Type": "Operational",
"Start": "2013-01-21"
},
{
"Type": "Legal",
"Start": "2013-04-01"
}
],
"Status": "Active",
"Target": {
"OrgId": {
"root": "2.16.840.1.113883.2.1.3.2.4.18.48",
"assigningAuthorityName": "HSCIC",
"extension": "XDH"
},
"PrimaryRoleId": {
"id": "RO126",
"uniqueRoleId": "128996"
}
},
"id": "RE3",
"uniqueRelId": 189272
}
]
},
"Succs": {
"Succ": [
{
"uniqueSuccId": 36589,
"Type": "Predecessor",
"Target": {
"OrgId": {
"root": "2.16.840.1.113883.2.1.3.2.4.18.48",
"assigningAuthorityName": "HSCIC",
"extension": "T1430"
},
"PrimaryRoleId": {
"id": "RO189",
"uniqueRoleId": "136318"
}
},
"Date": [
{
"Type": "Legal",
"Start": "2013-04-01"
}
]
},
{
"uniqueSuccId": 36688,
"Type": "Predecessor",
"Target": {
"OrgId": {
"root": "2.16.840.1.113883.2.1.3.2.4.18.48",
"assigningAuthorityName": "HSCIC",
"extension": "X09"
},
"PrimaryRoleId": {
"id": "RO116",
"uniqueRoleId": "111933"
}
},
"Date": [
{
"Type": "Legal",
"Start": "2013-04-01"
}
]
}
]
}
}
}
Return result in xml format rather than the default format of JSON:
https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/X26?_format=xml
<Organisation orgRecordClass="RC1">
<Name>NHS DIGITAL</Name>
<Date>
<Type value="Operational" />
<Start value="2013-01-21" />
</Date>
<Date>
<Type value="Legal" />
<Start value="2013-04-01" />
</Date>
<OrgId root="2.16.840.1.113883.2.1.3.2.4.18.48" assigningAuthorityName="HSCIC" extension="X26" />
<Status value="Active" />
<LastChangeDate value="2016-09-09" />
<GeoLoc>
<Location>
<AddrLn1>1 TREVELYAN SQUARE</AddrLn1>
<AddrLn2>BOAR LANE</AddrLn2>
<Town>LEEDS</Town>
<County>WEST YORKSHIRE</County>
<PostCode>LS1 6AE</PostCode>
<Country>ENGLAND</Country>
</Location>
</GeoLoc>
<Roles>
<Role id="RO116" uniqueRoleId="166234" primaryRole="true">
<Date>
<Type value="Operational" />
<Start value="2013-01-21" />
</Date>
<Date>
<Type value="Legal" />
<Start value="2013-04-01" />
</Date>
<Status value="Active" />
</Role>
</Roles>
<Rels>
<Rel id="RE3" uniqueRelId="189272">
<Date>
<Type value="Operational" />
<Start value="2013-01-21" />
</Date>
<Date>
<Type value="Legal" />
<Start value="2013-04-01" />
</Date>
<Status value="Active" />
<Target>
<OrgId root="2.16.840.1.113883.2.1.3.2.4.18.48" assigningAuthorityName="HSCIC" extension="XDH" />
<PrimaryRoleId id="RO126" uniqueRoleId="128996" />
</Target>
</Rel>
</Rels>
<Succs>
<Succ uniqueSuccId="36589">
<Date>
<Type value="Legal" />
<Start value="2013-04-01" />
</Date>
<Type>Predecessor</Type>
<Target>
<OrgId root="2.16.840.1.113883.2.1.3.2.4.18.48" assigningAuthorityName="HSCIC" extension="T1430" />
<PrimaryRoleId id="RO189" uniqueRoleId="136318" />
</Target>
</Succ>
<Succ uniqueSuccId="36688">
<Date>
<Type value="Legal" />
<Start value="2013-04-01" />
</Date>
<Type>Predecessor</Type>
<Target>
<OrgId root="2.16.840.1.113883.2.1.3.2.4.18.48" assigningAuthorityName="HSCIC" extension="X09" />
<PrimaryRoleId id="RO116" uniqueRoleId="111933" />
</Target>
</Succ>
</Succs>
</Organisation>
Example queries across a range of organisation types:
GP Practice (Prescribing Cost Centre with a Non Primary Role of GP Practice)
Last edited: 12 August 2021 10:56 am