ACED-IDP / aced-idp.github.io

Documentation Site for the ACED Data Commons
https://aced-idp.github.io/
Apache License 2.0
1 stars 0 forks source link

Task vs DiagnosticReport #10

Open bwalsh opened 6 months ago

bwalsh commented 6 months ago

Use case:

As an aced user, when I upload files, I may need to document how those files were created.

Current documentation:

A Task, or DiagnosticReport can provide provenance on how the file was created

See doc

image

Discussion

The Task entity seems appropriate:

A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.

However, it's output field contains a loosely typed array of value[x] image

Where value[x] is a term for

In FHIR XML and JSON, the value[x] element has an actual name of "value" and then the TitleCased name of one of these defined types, and its contents are those as defined for that type. see https://build.fhir.org/extensibility.html

The concern is that this loose coupling will require more support, more explanation and perhaps more bugs as analysts maintain meta data

For inputs, there are untyped references:

The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these.

Semantically, it would be better if they had named it AssayReport aka:

The findings and interpretation of assays performed on ...

Compared to Task, the edges are more complete and typed accordingly for these use cases: