CDCgov / prime-reportstream

ReportStream is a public intermediary tool for delivery of data between different parts of the healthcare ecosystem.
https://reportstream.cdc.gov
Creative Commons Zero v1.0 Universal
71 stars 40 forks source link

Replace File with Filename on Daily Data table #7851

Closed brick-green closed 1 year ago

brick-green commented 1 year ago

Problem statement

On Daily Data there's a column for File. The value in the field is almost always "HL7_BATCH". That value does not provide much value to users. Instead, that value should be the name of the file. This will give users an other option for identifying files that need further examination. For example, when a STLT sends a service request saying "The first message in file XYZ.csv has a missing field". Currently, the filename is not viewable in daily data. So it would have to be queried for. The file name can be accessed via the report_file table in the external_name column.

What you need to know

image.png [Links to documents, workflows, or list of key people and contact info]

Acceptance criteria

hannasage commented 1 year ago

Current response on /daily-data yields an array of this object shape from our Deliveries API:

{
  "deliveryId" : 12345678,
  "batchReadyAt" : "2022-12-16T20:06:00.658Z",
  "expires" : "2023-01-15T20:06:00.658Z",
  "receiver" : "org-name.receiver-setting",
  "reportId" : "b6c90d6d-6fc9-4458-9e66-ac66e5078032",
  "topic" : "covid-19", // or "full-elr" or "monkeypox"
  "reportItemCount" : 1,
  "fileName" : "covid-19-50221216200500-b6c90d7d-7fc9-4455-9e66-ac77e5078032-secondary.hl7",
  "fileType" : "HL7_BATCH"
}

@brick-green @stephenkao Make sure that the above fileName is the type of file name that's of use to the receiver. That is check that the filename is the same as the name of the file delivered to the Receiver's sftp site. Also, separately, check that, if you do a download, its the name of that file too.

chris-kuryak commented 1 year ago

@kevinhaube @stephenkao Do you think we have enough info on this one to begin refinement and slide it into the sprint backlog?

brick-green commented 1 year ago

Yep, fileName looks like the correct field to use. @kevinhaube also made a note that the field is quite long. That example seems longer than average but I might be wrong there. If space is an issue I think the reportID field could be truncated first. That field is not useful to STLTs, only to RS staff. Or perhaps this could be a place for the expanding field like what @jillian-hammer showed for the new message ID search results?

hannasage commented 1 year ago

@chris-kuryak Yep! And to Brick's point, I think in this work, we can fit in a change to the display text for the Report ID column. Maybe even shortening it to just an appropriate icon button with the column heading Details instead of it's current heading.

@jillian-hammer and @stephenkao Thoughts?

chris-kuryak commented 1 year ago

@brick-green For my own education, does the existing link (and now future link) under the FILE column download the file to your personal machine? And does that file contain PII (personally identifiable information)?

brick-green commented 1 year ago

@chris-kuryak yes it downloads to the folder you've set for downloads in your browser. the default is typically /downloads. Then yes that file does contain PII. It's exactly what's is sent out the the STLT

stephenkao commented 1 year ago

@chris-kuryak Yep! And to Brick's point, I think in this work, we can fit in a change to the display text for the Report ID column. Maybe even shortening it to just an appropriate icon button with the column heading Details instead of it's current heading.

@jillian-hammer and @stephenkao Thoughts?

Yep, sounds good to me! We can truncate/replace/display whatever we want, but I'd say the specifics here are Jillian's call 🙏

chris-kuryak commented 1 year ago

@brick-green Thanks!

hannasage commented 1 year ago

@chris-kuryak should deploy Tuesday, Jan 17! Will add "release notes" since this is a customer-facing change.

In short, where we used to show the file type, such as HL7 (BATCH), we now show the file name. Screenshot from staging:

Screen Shot 2023-01-13 at 11 17 22 AM