# Organisation Data Terminology - FHIR API - CodeSystem Parameter

**URL:** <https://developer.community.nhs.uk/t/organisation-data-terminology-fhir-api-codesystem-parameter/8865>\
**Category:** Organisation Data Service (ODS)\
**Tags:** fhir\
**Created:** [18 November 2025 10:55 UTC](https://developer.community.nhs.uk/t/organisation-data-terminology-fhir-api-codesystem-parameter/8865 "2025-11-18T10:55:45Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![Mahesh](https://avatars.discourse-cdn.com/v4/letter/m/9dc877/32.png) [@Mahesh](https://developer.community.nhs.uk/u/Mahesh)\
**Post date:** [18 November 2025 10:55 UTC](https://developer.community.nhs.uk/t/organisation-data-terminology-fhir-api-codesystem-parameter/8865/1 "2025-11-18T10:55:45Z")

</div>

Hello All,

I am working with ODT API, For the CodeSystem endpoint I have found 1 parameter within next relation _\_getpages=W%2F%228879750316029151521%22_ . Unable to access the next page pls check below SS

 ![image](https://europe1.discourse-cdn.com/nhsdigitaldeveloper/original/1X/cae4590e19a1be4bd352d8f31aa6ee8b29bc90be.png)

---

<div class="post-metadata">

**Author:** ![laura.reeves](https://avatars.discourse-cdn.com/v4/letter/l/d26b3c/32.png) [@laura.reeves](https://developer.community.nhs.uk/u/laura.reeves)\
**Post date:** [18 November 2025 12:00 UTC](https://developer.community.nhs.uk/t/organisation-data-terminology-fhir-api-codesystem-parameter/8865/2 "2025-11-18T12:00:00Z")

</div>

Hi

Are you able to provide some more info re what you are trying to achieve/data you need to return? Have you seen the guidance docs and sandbox - links below if helpful:

OAS Spec and CodeSystem info: [Organisation Data Terminology - FHIR API - NHS England Digital](https://digital.nhs.uk/developer/api-catalogue/organisation-data-terminology) and [CodeSystem - NHS England Digital](https://digital.nhs.uk/services/organisation-data-service/codesystem)

Implementation Guidance: [Organisation Data Service (ODS) Implementation Guide](https://simplifier.net/guide/organisation-data-services?version=1.2.0-beta)

Postman Sandbox: [organisation data service FHIR R4 API Sandbox for organisation-data-terminology API](https://documenter.getpostman.com/view/26163840/2sA3dvmD94)

ODS Reference Data Catalogue (Data Model etc): [ODS (Organisation Data Service)](https://www.odsdatasearchandexport.nhs.uk/referenceDataCatalogue/index.html)

Thanks

---

<div class="post-metadata">

**Author:** ![Mahesh](https://avatars.discourse-cdn.com/v4/letter/m/9dc877/32.png) [@Mahesh](https://developer.community.nhs.uk/u/Mahesh)\
**Post date:** [20 November 2025 13:08 UTC](https://developer.community.nhs.uk/t/organisation-data-terminology-fhir-api-codesystem-parameter/8865/3 "2025-11-20T13:08:49Z")

</div>

Hello,

Thanks for the response Laura. I am looking for **Succession (Successor/Predecessor) Details.** I couldn’t understand on how these relationships using the OrganisationAffiliation endoint in FHIR R4 with reference to the ‘[https://digital.nhs.uk/services/organisation-data-service/codesystem/odsrelationship](https://digital.nhs.uk/services/organisation-data-service/codesystem/odsrelationship)‘ CodeSystem. Is there any explicit code or value that denotes an organisation is a successor or a predecessor? How can it be identified within the OrganisationAffiliation/Orgnisation resource?

Appreciate your response on this. Thanks

---

<div class="post-metadata">

**Author:** ![laura.reeves](https://avatars.discourse-cdn.com/v4/letter/l/d26b3c/32.png) [@laura.reeves](https://developer.community.nhs.uk/u/laura.reeves)\
**Post date:** [20 November 2025 17:07 UTC](https://developer.community.nhs.uk/t/organisation-data-terminology-fhir-api-codesystem-parameter/8865/4 "2025-11-20T17:07:39Z")

</div>

Hi Mahesh

We provided some examples re Succession to another customer so I have the following to hand which hopefully helps explain what data is available where.

Thanks

–

Get predecessors for an organisation:

-[https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=5CC&property=predecessor](https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=5CC&property=predecessor)

Get successors for an organisation:

-[https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=5CC&property=successor](https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://fhir.nhs.uk/Id/ods-organization-code&code=5CC&property=successor)

Get a summary of the properties available in the succession codesystem (same principle applies for other codesystems):

-[https://sandbox.api.service.nhs.uk/organisation-data-terminology-api//fhir/CodeSystem?url=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/succession](https://sandbox.api.service.nhs.uk/organisation-data-terminology-api//fhir/CodeSystem?url=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/succession)

Get info from the succession codesystem - if you know the succession ID you can use this:

[https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/succession&code=36551&property=](https://sandbox.api.service.nhs.uk/organisation-data-terminology-api/fhir/CodeSystem/$lookup?system=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/succession&code=36551&property=)\*

You can find succession IDs, among other info, by doing the following POST call with raw JSON body text shown under the url:

“resourceType”: “Parameters”,  
“parameter”: [  
{  
“name”: “valueSet”,  
“resource”: {  
“resourceType”: “ValueSet”,  
“compose”: {  
“inactive”: true,  
“include”: [  
{  
“system”: “[https://digital.nhs.uk/services/organisation-data-service/CodeSystem/succession”](https://digital.nhs.uk/services/organisation-data-service/CodeSystem/succession%E2%80%9D),  
“filter”: [  
{  
“property”: “successor”,  
“op”: “=”,  
“value”: “5CC”  
}  
]  
}  
]  
}  
}  
},  
{  
“name”: “activeOnly”,  
“valueBoolean”: false  
},  
{  
“name”: “property”,  
“valueString”: “successor”  
},  
{  
“name”: “property”,  
“valueString”: “predecessor”  
},  
{  
“name”: “property”,  
“valueString”: “legStartDate”  
}  
]  
}