Generate enum classes #10

ellykits · 2025-04-30T23:57:39Z

Fixes #7

It's a good idea to open an issue first for discussion.

Tests pass
Appropriate changes to documentation are included in the PR

Signed-off-by: Elly Kitoto <[email protected]>

Content for enum classes are retrieved from ValuSet and CodeSet Terminology resources. Some enums are generated as nested classes in the generated FHIR models, if the element declared in the StructureDefinition is not a common binding element. Example is the NameUse enum class of class HumanName (used in Patient model). Signed-off-by: Elly Kitoto <[email protected]>

Signed-off-by: Elly Kitoto <[email protected]>

ellykits · 2025-05-01T08:57:44Z

TBD:

Use the generated enum types
Some types in r4b and r5 require version 3 ValueSet & CodeSystem from r4
Refactor Code.of methods for Surrogate classes. (Should resolve the issues with running tests)
Fix usage of inherited enumarated codes like Count, Age, inheriting from Quantity. The inheriting class should use the Enum created in the parent class.

jingtang10 · 2025-05-02T08:32:33Z

@ellykits this looks great so far - just a small comment first: i think the new schema files can be simplified. there's no need to include fields that we don't need from the spec's json files.

Signed-off-by: Elly Kitoto <[email protected]>

These functions are used in the Surrogate classes Signed-off-by: Elly Kitoto <[email protected]>

Signed-off-by: Elly Kitoto <[email protected]>

Exclude geration of enum class for a class with conflicting commong binding name. Signed-off-by: Elly Kitoto <[email protected]>

Copilot

Pull Request Overview

This PR adds support for generating enum classes from FHIR value sets and improves the handling of element bindings. Key changes include the introduction of new schema data classes (ValueSet, Binding, etc.), updates to surrogate and model type generation to integrate enum types based on FHIR value sets, and enhancements to the FhirCodegen task for processing ValueSet and CodeSystem files.

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/schema/ValueSet.kt	New schema definitions for ValueSet, Compose, and Include.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/schema/StructureDefinition.kt	Added a new binding property and a related Binding data class.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/schema/MoreStructureDefinitions.kt	Introduced constants and helper extensions for common binding and enum processing.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/FhirEnum.kt	New file for FHIR enum representations.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/primitives/EnumerationTypeGenerator.kt	Generates FHIR Enumeration types used in the model.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/SurrogateTypeSpecGenerator.kt	Updated to pass through and handle value set mappings for enum generation.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/ModelTypeSpecGenerator.kt	Modified to generate nested enum classes and adjust property types when enum types are present.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/FhirCodegenTask.kt	Enhanced to include processing of ValueSet and CodeSystem files and to trigger enum generation.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/FhirCodegen.kt	Updated method signatures to include new mapping parameters for enum generation.
fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/EnumTypeSpecGenerator.kt	New generator for Kotlin enum types based on FHIR concepts and value sets.

Comments suppressed due to low confidence (1)

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/schema/MoreStructureDefinitions.kt:241

[nitpick] Avoid using println for debugging in production code; consider using a structured logging framework to log diagnostic information.

println("Look here..... is the element" + Json { prettyPrint = true }.encodeToString(element))

Copilot · 2025-05-21T23:21:04Z

...gen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/schema/MoreStructureDefinitions.kt

+fun Include.isValueSystemSupported(): Boolean =
+  !system.isNullOrBlank() &&
+    !system.startsWith("urn", ignoreCase = true) &&
+    system !in setOf("http://hl7.org/fhir/specimen-combined", "http://unitsofmeasure.org", true)


The set passed to 'system !in setOf(...)' incorrectly includes a boolean value (true) among strings. Please remove the boolean value to ensure proper string comparisons.

Suggested change

system !in setOf("http://hl7.org/fhir/specimen-combined", "http://unitsofmeasure.org", true)

system !in setOf("http://hl7.org/fhir/specimen-combined", "http://unitsofmeasure.org")

jingtang10

Please add some documentation to the README.md file.

I would suggest either modify the table in Mapping FHIR data structure to Kotlin section, or add a new section specifically about mapping enums.

jingtang10 · 2025-05-21T23:20:51Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/EnumTypeSpecGenerator.kt

+import com.squareup.kotlinpoet.TypeSpec
+import com.squareup.kotlinpoet.asTypeName
+
+object EnumTypeSpecGenerator {


documentation

jingtang10 · 2025-05-22T09:02:06Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/EnumTypeSpecGenerator.kt

+    valueSet: ValueSet,
+    codeSystemMap: Map<String, CodeSystem>,
+  ): TypeSpec? {
+


remove empty line

jingtang10 · 2025-05-22T12:11:35Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/ModelTypeSpecGenerator.kt

+    if (valueSetUrl == "http://hl7.org/fhir/ValueSet/specimen-combined") {
+      println("Look here..... is the element" + Json { prettyPrint = true }.encodeToString(element))
+    }


remove the debugging code?

jingtang10 · 2025-05-22T12:42:12Z

...gradle-plugin/src/main/kotlin/com/google/fhir/codegen/primitives/EnumerationTypeGenerator.kt

+    val version = packageName.substringAfterLast('.')
+    val isR5 = version.equals("r5", ignoreCase = true)
+
+    val superclassName = ClassName(packageName, if (isR5) "PrimitiveType" else "Element")


why's this?

jingtang10 · 2025-05-22T12:48:36Z

...gradle-plugin/src/main/kotlin/com/google/fhir/codegen/primitives/EnumerationTypeGenerator.kt

+                      .copy(nullable = true),
+                )
+                .addKdoc(
+                  """


is it possible to pull these comments automatically from somewhere rather than hardcoding them?

if not, i'd write something a bit more generic/meta than this - focus on the fact that these are hand generated to match the parent class.

jingtang10 · 2025-05-22T12:58:18Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/EnumTypeSpecGenerator.kt

+        .apply {
+          fhirEnum.description?.sanitizeKDoc()?.let { addKdoc(it) }
+          primaryConstructor(
+            FunSpec.constructorBuilder().addParameter("code", String::class).build()


question: should the enum values just include system, display, and definition fields?

jingtang10 · 2025-05-22T12:59:51Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/EnumTypeSpecGenerator.kt

+          addFunction(
+            FunSpec.builder("getSystem")
+              .addStatement("return %S", fhirEnum.getSystem() ?: "")
+              .returns(String::class)


nit: move the .returns up, since it's part of the function signature, and then addStatement

jingtang10 · 2025-05-22T13:01:39Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/schema/FhirEnum.kt

+  val constants: List<FhirEnumConstant> = emptyList(),
+) {
+  fun getSystem(): String? {
+    return constants.firstOrNull()?.system


is this correct? does an enum always have the only one code system?

seems to me it can include multiple code systems.

jingtang10 · 2025-05-22T13:02:49Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/schema/FhirEnum.kt

+import kotlinx.serialization.Serializable
+
+@Serializable
+data class FhirEnum(


does this really belong in the schema package? seems to me this is an intermediary class rather than something you deserialise from the specification's' json files?

jingtang10 · 2025-05-22T13:05:44Z

fhir-codegen/gradle-plugin/src/main/kotlin/com/google/fhir/codegen/EnumTypeSpecGenerator.kt

+    if (valueSet.compose?.include.isNullOrEmpty()) return null
+    val includes = valueSet.compose.include.filter { it.isValueSystemSupported() }


you can do something like

valueSet.compose?.include?.let { ... }

to simplify the code

ellykits added 7 commits May 1, 2025 02:44

Implement models for ValueSet and CodeSystem

acb26cd

Signed-off-by: Elly Kitoto <[email protected]>

Update StructureDefinition model to inlcude Binding property

c3d4f4f

Signed-off-by: Elly Kitoto <[email protected]>

Implement TypeSpec for generating enum classes

3e93a3a

Signed-off-by: Elly Kitoto <[email protected]>

Merge branch 'google:main' into implement-enums

e5ef44c

Delete commented code

78eec34

Signed-off-by: Elly Kitoto <[email protected]>

Fix imports

22f9d1f

Signed-off-by: Elly Kitoto <[email protected]>

ellykits added 6 commits May 2, 2025 14:53

Implement EnumerationTypeGenerator

94a0337

Signed-off-by: Elly Kitoto <[email protected]>

Wrap enumarated codes type with Enumeration class

4738d83

Signed-off-by: Elly Kitoto <[email protected]>

Fix using enums types for r4 and r4b

8df843a

Signed-off-by: Elly Kitoto <[email protected]>

Implement Enumeration of and toElement functions

3d52009

These functions are used in the Surrogate classes Signed-off-by: Elly Kitoto <[email protected]>

Resolve issues with generated surrogate classes

e803d2e

Signed-off-by: Elly Kitoto <[email protected]>

Delete unused properties

921df63

Signed-off-by: Elly Kitoto <[email protected]>

ellykits closed this May 12, 2025

ellykits added 3 commits May 12, 2025 21:56

Implement functionality for retrieving enum constant from code

428e133

Signed-off-by: Elly Kitoto <[email protected]>

Implement the control getDisplay and getDefinition methods

3ac0125

Signed-off-by: Elly Kitoto <[email protected]>

Fix enum constant formatting

0f4bc97

Signed-off-by: Elly Kitoto <[email protected]>

ellykits reopened this May 12, 2025

ellykits added 4 commits May 13, 2025 00:41

Generate enums only for commonbinding elements

641f441

Signed-off-by: Elly Kitoto <[email protected]>

Revert json formatting

fd7790e

Signed-off-by: Elly Kitoto <[email protected]>

Fix failing test

0a2d310

Exclude geration of enum class for a class with conflicting commong binding name. Signed-off-by: Elly Kitoto <[email protected]>

Merge branch 'main' into implement-enums

9f6e905

ellykits marked this pull request as ready for review May 12, 2025 22:51

ellykits requested a review from jingtang10 May 12, 2025 22:54

ellykits self-assigned this May 13, 2025

jingtang10 requested a review from Copilot May 21, 2025 23:20

Copilot AI reviewed May 21, 2025

View reviewed changes

jingtang10 requested changes May 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Generate enum classes #10

Generate enum classes #10

Uh oh!

ellykits commented Apr 30, 2025 •

edited

Loading

Uh oh!

ellykits commented May 1, 2025 •

edited

Loading

Uh oh!

jingtang10 commented May 2, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 21, 2025

Uh oh!

jingtang10 left a comment

Uh oh!

jingtang10 May 21, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

jingtang10 May 22, 2025

Uh oh!

Uh oh!

	system !in setOf("http://hl7.org/fhir/specimen-combined", "http://unitsofmeasure.org", true)
	system !in setOf("http://hl7.org/fhir/specimen-combined", "http://unitsofmeasure.org")

		if (valueSet.compose?.include.isNullOrEmpty()) return null
		val includes = valueSet.compose.include.filter { it.isValueSystemSupported() }

Generate enum classes #10

Are you sure you want to change the base?

Generate enum classes #10

Uh oh!

Conversation

ellykits commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ellykits commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jingtang10 commented May 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 21, 2025

Choose a reason for hiding this comment

Uh oh!

jingtang10 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ellykits commented Apr 30, 2025 •

edited

Loading

ellykits commented May 1, 2025 •

edited

Loading