Retire a Term

[AngelaFaulding]

Could you please explain how to retire a Term.

So far in the Test Branch I have retired code 3 of RADICAL PROSTATECTOMY MARGIN STATUS

I have checked the Orchestrator and nothing different is showing to before:

Retired items should display, for example as in: https://www.datadictionary.nhs.uk/data_elements/planned_cancer_treatment_type.html

The retired text in bracket is added by us. Where do we add it in Mauro?

Do we just ignore web presentation for this?

• For items that have no web presentation as in the example above
• For items that have web presentation, see below:

I have noticed that the item below has the text in the Definition field.

Is it the Definition field that we use for this?

[AngelaFaulding]

Peter thinks that if we add a date in the profile, that should display on the Orchestrator. He will look into this.

[pjmonks]

This issue has been fixed and deployed to TEST, TRAINING and LIVE. Please move this to the "Ready for NHS E Testing" state.

[pjmonks]

The fix was that marking a Term as retired now automatically adds text to the end of the name in the Orchestrator preview to say it is retired, and when. We have ingested a number of branches which have already saved this text to name of the Term, so if a Term already has a "(Retired dd MMM yyyy)" suffix, it will not be duplicated - you must remove it from the name before testing the "Is retired" checkbox.

[AngelaFaulding]

@pjmonks - I have created a new branch (CR8008) and retired the same items as above.

The retired text is displaying but the date isn't present. I have added a retired date to both terms but it does not display on the preview. How do we ensure the retired date is included as in the example I supplied above, i.e. https://www.datadictionary.nhs.uk/data_elements/planned_cancer_treatment_type.html which has the retied dates.

[pjmonks]

It is because the date you've entered is not in a format it was expecting, but the format it is expecting would be too confusing to use. I'll fix it:

• MauroDataMapper-NHSD/mdm-plugin-nhs-data-dictionary#127

[AngelaFaulding]

Ticket moved as Peter needs to fix this.

[pjmonks]

I have deployed a fix to TEST to correctly display the retired terms on the preview/DITA pages.

To retire a term in an Attribute Terminology:

1. Select the term to edit.
2. Select the "NHS Data Dictionary - Term" profile

3. Click on "Edit", then tick "Is retired" and enter a date in the "Retired date" field e.g. "1 September 2024"

The text you enter for the retired date will appear exactly as you've written it, because it the field is not set to a date type.

Also note that a lot of terms have been ingested already and look like this:

If you are making a new term or changing term to now be retired, please follow my first set of instructions. However, because a lot of these ingested terms already exist, the "Retired" text for a term does not duplicate information - in these cases, the text on the item label takes precedence. If you want to change this:

1. Change the "Retired date" field to a different text value that you want to display e.g. "1 April 2024"
2. Remove the "Retired" text from the label.
3. Now the preview/DITA for the term will match what I originally described.

[AngelaFaulding]

@pjmonks - I'm not sure what you mean as this is what I entered:

I have not touched the item you describe above, that code is retired in the live dictionary:

The item I updated is now showing as correct:

Can you please confirm that all existing retired codes will work OK if they are in the format which you say is not correct? You say we can change them, but there are so many we wouldn't want to do that.

Also, the Data Element is not displaying it's description. Is this linked to #381 ?

[pjmonks]

I will break down my response:

RADICAL PROSTATECTOMY MARGIN STATUS terms

I assume this was not retired before, but is now. This term has been newly retired correctly, because the retired date/status is not part of the label of the term itself, and the retired date is set by yourself - it will appear exactly as you've written it.

ABLATIVE THERAPY TYPE terms

I assume these terms were retired beforehand and ingested from Borland Together. This is why the retired date is written in a very precise format, but you probably don't want that date format to appear. This is why I think James has written the ingest process to put the date directly into the label of the term (or that was the label provided to us by your ingest file, I do not know ). Nonetheless, I've made sure that this appears in the same way as RADICAL PROSTATECTOMY MARGIN STATUS:

Conclusion

You do not have to change any previously retired terms. If you need to retire a new term going forward, follow the process you have done for RADICAL PROSTATECTOMY MARGIN STATUS.

Missing Description

I've checked why Data Element RADICAL PROSTATECTOMY MARGIN STATUS description is not appearing and it is quite simple - there is no description to display.

I do not know why there is no description, but it is ultimately a content issue that can easily fixed by yourselves.

[KatePalmerLilley]

The description issue appears to be #381

[KatePalmerLilley]

@AngelaFaulding Can we discuss what a retired term is supposed to look like in the new DD? In the Orch it correctly shows the retired date:

Is that all we expect now? I know in the old DD the text was greyed out.

Looking for an example I came across a bit of a mix https://www.datadictionary.nhs.uk/attributes/area_of_work_name.html

[AngelaFaulding]

@jamesrwelch - please see https://www.datadictionary.nhs.uk/attributes/cancer_treatment_intent.html. Is the DITA set up so all retired National Codes are shown in a grey row?

[AngelaFaulding]

This may not be good for accessibility. James will investigate.