Organisation Data Terminology - FHIR API - CodeSystem Parameter

Organisation Data Service (ODS)
1

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
image1262×491 34.8 KB

2

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 and CodeSystem - NHS England Digital

Implementation Guidance: Organisation Data Service (ODS) Implementation Guide

Postman Sandbox: organisation data service FHIR R4 API Sandbox for organisation-data-terminology API

ODS Reference Data Catalogue (Data Model etc): ODS (Organisation Data Service)

Thanks

3

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‘ 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

4

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

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

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

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=*

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”,
“filter”: [
{
“property”: “successor”,
“op”: “=”,
“value”: “5CC”
}
]
}
]
}
}
},
{
“name”: “activeOnly”,
“valueBoolean”: false
},
{
“name”: “property”,
“valueString”: “successor”
},
{
“name”: “property”,
“valueString”: “predecessor”
},
{
“name”: “property”,
“valueString”: “legStartDate”
}
]
}