ga4gh / ga4gh/phenopacket-schema

MedicalAction action field in doc could be changed to a more detailed field

Open
#347 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
101
Forks
34
PR merge metrics
No merged PRs in 30d

Description

In MedicalAction, there is the "action" field which can be either of type Procedure, Treatment, RadiationTherapy or TherapeuticRegimen. Instead of it being named "action" (in a phenopacket json file that is generated with the phenopacket-tools, there is no such field/id), we could indicate that the id in the corresponding json is either "procedure", "treatment", "radiationTherapy" or "therapeuticRegimen".

Contributor guide

Open the contributing guide

Research direction

Locate MedicalAction in the phenopacket schema and inspect how phenopacket-tools generates its JSON. Confirm how the action field is represented and determine whether the output should use procedure, treatment, radiationTherapy, or therapeuticRegimen as the corresponding identifier. Done means the schema and generated JSON consistently use the more specific field names.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, json
Domain
backend-api-design
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.