Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the definition of each code to Code subtype constants and ValueSet values #743

Closed
lmsurpre opened this issue Mar 2, 2020 · 0 comments
Assignees
Labels
good first issue Good for newcomers
Milestone

Comments

@lmsurpre
Copy link
Member

lmsurpre commented Mar 2, 2020

Is your feature request related to a problem? Please describe.
Currently we generate Code SubTypes in the package com.ibm.fhir.model.type.code.
While working with values from this package, you need to understand what the allowed code values mean.
Currently, we add only the "display" value as javadoc which is typically almost the same as the constant's name. This is sufficient for some cases, but since the spec also includes a definition for each code, that would be good to add.

Describe the solution you'd like
Currently we have:

    /**
     * Invalid Content
     */
    public static final IssueType INVALID = IssueType.builder().value(ValueSet.INVALID).build();

What I'd like is:

    /**
     * Invalid Content
     *
     * <p>Content invalid against the specification or a profile.
     */
    public static final IssueType INVALID = IssueType.builder().value(ValueSet.INVALID).build();

Note: these classes under com.ibm.fhir.model.type.code are generated and so the "real" change would be to:

  1. update fhir-tools to include the definition in the javadoc
  2. regenerate the model
  3. push all related changes (including the fhir-tools update)

I'd like the javadoc updated on both the constant AND the corresponding ValueSet enum.

source: https://www.hl7.org/fhir/valueset-issue-type.html

Describe alternatives you've considered
Just navigate to the corresponding spec page and read the definitions there.

@lmsurpre lmsurpre added the good first issue Good for newcomers label Mar 2, 2020
JohnTimm added a commit that referenced this issue Mar 3, 2020
Signed-off-by: John T.E. Timm <johntimm@us.ibm.com>
JohnTimm added a commit that referenced this issue Mar 3, 2020
Signed-off-by: John T.E. Timm <johntimm@us.ibm.com>
JohnTimm added a commit that referenced this issue Mar 3, 2020
* Issue #743 - added definition to Javadoc

Signed-off-by: John T.E. Timm <johntimm@us.ibm.com>

* Issue #743 - reverted class annotation order per PR feedback

Signed-off-by: John T.E. Timm <johntimm@us.ibm.com>
@JohnTimm JohnTimm self-assigned this Mar 3, 2020
@JohnTimm JohnTimm added this to the Sprint 9 milestone Mar 3, 2020
@lmsurpre lmsurpre closed this as completed Mar 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants