search

NHSDigital / DataDictionaryPublication

Apache License 2.0
7 stars 1 forks source link

Change Request errors in DITA #540

Open stevebowring opened 3 months ago

stevebowring commented 3 months ago

When comparing Mauro & Together versions of Change Request 1915 a number of errors were identified.

For example:

Data Element: Organisation Site Identifier (of imaging) - missing Default Codes Data Element: Diagnostic Test (Retired) - missing 'last version' text Attribute: Service Report Issue Time - missing 'Unretired' status

NellySSJ commented 2 months ago

https://github.com/orgs/NHSDigital/projects/35

pjmonks commented 2 months ago

It is possible Default Codes was missed because it wasn't very clear from the original change paper.

I'm afraid I don't know what "last version text" or "unretired status" refers to. I tried looking at the original CR1915 change paper but it wasn't obvious to me. Please could you provide further details?

NellySSJ commented 2 months ago

Hi @pjmonks

@stevebowring did some work flagging the missing content (he's away until Monday), but I was able to find the following below which shows the comparison of CR1915 how it displays output using Together (on left) and Mauro (on right). The red post its are the ones for investigation...

Data Element: Organisation Site Identifier (of imaging) - missing Default Codes missing Default Codes

Data Element: Diagnostic Test (Retired) - missing 'last version' text image

Attribute: Service Report Issue Time - missing 'Unretired' status Service Report Issue Time

pjmonks commented 2 months ago

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

pjmonks commented 2 months ago

To test, run a change paper preview or DITA publish and verify the changes you requested are now present.

AngelaFaulding commented 2 months ago

@stevebowring and @NellySSJ - I have run the CRs though the DDPM. Attached are the pdfs for the basic and data set CRs. One has the data set and the other doesn't. One has the styling and the other doesn't. web (9).zip web (8).zip

AngelaFaulding commented 2 months ago

@stevebowring and @NellySSJ - I have run the CRs though the DDPM. @likin1 - it only works if you don't change the ID, which we would want to. Attached are the pdfs for the basic and data set CRs. The basic doesn't include the date set and the data set one does. I think this is linked to the issue with the Orchestrator showing / not showing the data set' #525. web (11).zip web (10).zip

AngelaFaulding commented 2 months ago

@stevebowring - this is the dita for the 2 CRs above. change-paper-CRXXXX-datasets-18-09-2024.zip change-paper-CRXXXX-basic-18-09-2024.zip

AngelaFaulding commented 1 month ago

01/10/24 - @stevebowring - attached is the new DITA for CR1915. I will run the CRs and add them here later. change-paper-CR1915-datasets-01-10-2024.zip change-paper-CR1915-basic-01-10-2024.zip

AngelaFaulding commented 1 month ago

@stevebowring - I can't access the DDPM so won't be able to run any CRs. I have asked @likin1 to investigate.

likin1 commented 1 month ago

@AngelaFaulding I can access DDPM . Its due to you moving to common desktop. Have you had a chance to speak to the IT sevrices?

AngelaFaulding commented 1 month ago

@likin1 - let's talk about this on the standup please. As this is a Data Solutions product, will ICT know anything about this?

AngelaFaulding commented 1 month ago

web (1).zip web.zip

stevebowring commented 3 weeks ago

@pjmonks - I can't see any National or Default codes in our CR1915. I think we were expecting to see some as they were included in the original Together produced CR1915.

It's possible that they aren't in the new version because no Codes were changed - but it would be good to confirm it either way.

AngelaFaulding commented 2 weeks ago

The original CR does have default codes: image

@pjmonks - why are they not in the new version:

image

Why does the CR say "Change to Data Element: Format / Length, Updated description, Aliases" when the Format/Length has not been updated.

Can the right hand menu titles be included in the CR? image

pjmonks commented 2 weeks ago

@AngelaFaulding and @stevebowring - I have looked over this last comment https://github.com/NHSDigital/DataDictionaryPublication/issues/540#issuecomment-2459366677.

Default codes

There are two reasons why default codes are not appearing in CR1915 for ORGANISATION SITE IDENTIFIER (OF IMAGING):

  1. There are literally no default codes available for that element in Mauro. Look at this Orchestrator preview:

image

And look at the element in Mauro:

image

If no code set is available, then the change paper is accurate in the content it has available. The real problem is why isn't there an attribute terminology or code set? That is because of a problem with the ingest, which is issue #488. That is a separate issue to the content within Mauro which should not affect testing the change paper.

  1. Even if default codes were available, if they had not changed between the change request branch and the last release then they still would not appear in the change paper. I refer you to what we agreed would be contained in the change paper here https://github.com/NHSDigital/DataDictionaryPublication/issues/525#issuecomment-2385124488, specifically the "Updated items" section:

If a dictionary item is updated, only the specific changes are included in the change paper. For example, if an Element's description was modified, only the description is listed as a change - all other sub-sections (National/Default Codes, Format/Length, Aliases etc) are not included.

This means that parts of the item only get included as a change when modified. An item may include multiple changes - e.g. a description and an attribute change for a class - but is not required to display the entire definition of the item.

Format length

I have downloaded CR1915 as a change paper today and created it's PDF, there is no "Format/Length" under ORGANISATION SITE IDENTIFIER (OF IMAGING):

CR1915-TEST-06-11-2024.pdf

Which content are you looking at? Because this looks correct to me.

TOC section

Back to what was agreed between us in what would appear in the change paper https://github.com/NHSDigital/DataDictionaryPublication/issues/525#issuecomment-2385124488, table of contents per item were not included in that list. That can be planned as future work.

AngelaFaulding commented 2 weeks ago

@jamesrwelch - is this something you can help with as this will prevent migration? This is linked to #528