Setting the Status in ODS

Status has been adopted on the following components in ODS data to allow consumers to filter content if required:

• Organisation
• Roles
• Relationships

Including Status allows consuming systems to bypass/ignore records or components that are inactive.

The rule applied is that where Status is included the component remains Active until all Date elements of any Type (legal or operational) associated with that component also have their End elements populated with an End Date.

Note that operational start dates cannot be in the future, but legal start dates can.

The table below illustrates Status:

Sub Status of Proposed

The main Status for records is either ACTIVE or INACTIVE as detailed above.

However, there is a Sub Status of 'PROPOSED' calculated for any records with an operational start date of today or in the past, but a future legal start date.

The overarching status for Proposed records is always ACTIVE.

Sub Status of Dormant for Prescribing Cost Centres 

Prescribing Cost Centre (including GP Practice) codes are owned and maintained by the NHS BSA Prescription Service, but shared with and onward published by ODS. When a prescribing cost centre code is no longer required, the code must be left open by the BSA for a period of up to 12 months, to allow for any issued prescriptions to be fully processed. During this period the BSA refer to the code as 'Dormant'.

There are no start/end dates that accompany the dormant status - the BSA only provide ODS with a flag that indicates the code has been made dormant.

It is possible for a code to be made active again, if the planned closure is reversed. If the closure proceeds, once the dormancy period has passed, the BSA then consider the code closed/inactive and end dates are applied accordingly. 

The overarching status for Dormant records in ODS is always ACTIVE.

Querying Sub Status

Organisation Data Terminology FHIR API

In the Organisation Data Terminology FHIR API, the only categories returned in the Organisation 'StatusName' field will be ACTIVE or INACTIVE.

The Additional Attributes CodeSystem can be queried to return a sub status data of 'Proposed' and 'Dormant' (dormant - for Prescribing Cost Centre codes only).

Refer to the Additional Attributes data model page for further information.

Data Search and Export 

The Status parameter available when creating an advanced search in DSE, is limited to the overarching code status of ACTIVE or INACTIVE. If you wish to return dormant and/or proposed records then the Status parameter should be set to ACTIVE.

If you include Status as a column in the search results, you can filter on PROPOSED / ACTIVE / DORMANT / INACTIVE, noting that dormant is only used for Prescribing Cost Centre records.

Status on Relationships with Legal Dates only 

Instances do exist where relationships have legal start and end dates without a corresponding set of operational dates. These exist due to legacy conditions when operational changes to support major NHS reconfiguration were managed outside of ODS internal systems (directly on Spine). In these cases only the legal dates will be published for a given relationship. Component Status for this scenario is illustrated below.