Issue #646 - Define a Narrative.EMPTY constant

Signed-off-by: Troy Biesterfeld <[email protected]>

Author: tbieste

fhir-model/src/main/java/com/ibm/fhir/model/type/Narrative.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -38,6 +38,8 @@
 )
 @Generated("com.ibm.fhir.tools.CodeGenerator")
 public class Narrative extends Element {
+    public static final Narrative EMPTY = builder().status(NarrativeStatus.EMPTY).div(Xhtml.from("Narrative text intentionally left empty")).build();
+
     @Binding(
         bindingName = "NarrativeStatus",
         strength = BindingStrength.ValueSet.REQUIRED,
@@ -59,9 +61,9 @@ private Narrative(Builder builder) {
     }
 
     /**
-     * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or 
+     * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or
      * whether a human authored it and it may contain additional data.
-     * 
+     *
      * @return
      *     An immutable object of type {@link NarrativeStatus} that is non-null.
      */
@@ -71,7 +73,7 @@ public NarrativeStatus getStatus() {
 
     /**
      * The actual narrative content, a stripped down version of XHTML.
-     * 
+     *
      * @return
      *     An immutable object of type {@link Xhtml} that is non-null.
      */
@@ -81,8 +83,8 @@ public Xhtml getDiv() {
 
     @Override
     public boolean hasChildren() {
-        return super.hasChildren() || 
-            (status != null) || 
+        return super.hasChildren() ||
+            (status != null) ||
             (div != null);
     }
 
@@ -114,19 +116,19 @@ public boolean equals(Object obj) {
             return false;
         }
         Narrative other = (Narrative) obj;
-        return Objects.equals(id, other.id) && 
-            Objects.equals(extension, other.extension) && 
-            Objects.equals(status, other.status) && 
+        return Objects.equals(id, other.id) &&
+            Objects.equals(extension, other.extension) &&
+            Objects.equals(status, other.status) &&
             Objects.equals(div, other.div);
     }
 
     @Override
     public int hashCode() {
         int result = hashCode;
         if (result == 0) {
-            result = Objects.hash(id, 
-                extension, 
-                status, 
+            result = Objects.hash(id,
+                extension,
+                status,
                 div);
             hashCode = result;
         }
@@ -151,12 +153,12 @@ private Builder() {
         }
 
         /**
-         * Unique id for the element within a resource (for internal references). This may be any string value that does not 
+         * Unique id for the element within a resource (for internal references). This may be any string value that does not
          * contain spaces.
-         * 
+         *
          * @param id
          *     Unique id for inter-element referencing
-         * 
+         *
          * @return
          *     A reference to this Builder instance
          */
@@ -166,16 +168,16 @@ public Builder id(java.lang.String id) {
         }
 
         /**
-         * May be used to represent additional information that is not part of the basic definition of the element. To make the 
-         * use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of 
-         * extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part 
+         * May be used to represent additional information that is not part of the basic definition of the element. To make the
+         * use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of
+         * extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part
          * of the definition of the extension.
-         * 
+         *
          * <p>Adds new element(s) to the existing list
-         * 
+         *
          * @param extension
          *     Additional content defined by implementations
-         * 
+         *
          * @return
          *     A reference to this Builder instance
          */
@@ -185,16 +187,16 @@ public Builder extension(Extension... extension) {
         }
 
         /**
-         * May be used to represent additional information that is not part of the basic definition of the element. To make the 
-         * use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of 
-         * extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part 
+         * May be used to represent additional information that is not part of the basic definition of the element. To make the
+         * use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of
+         * extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part
          * of the definition of the extension.
-         * 
+         *
          * <p>Replaces the existing list with a new one containing elements from the Collection
-         * 
+         *
          * @param extension
          *     Additional content defined by implementations
-         * 
+         *
          * @return
          *     A reference to this Builder instance
          */
@@ -204,14 +206,14 @@ public Builder extension(Collection<Extension> extension) {
         }
 
         /**
-         * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or 
+         * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or
          * whether a human authored it and it may contain additional data.
-         * 
+         *
          * <p>This element is required.
-         * 
+         *
          * @param status
          *     generated | extensions | additional | empty
-         * 
+         *
          * @return
          *     A reference to this Builder instance
          */
@@ -222,12 +224,12 @@ public Builder status(NarrativeStatus status) {
 
         /**
          * The actual narrative content, a stripped down version of XHTML.
-         * 
+         *
          * <p>This element is required.
-         * 
+         *
          * @param div
          *     Limited xhtml content
-         * 
+         *
          * @return
          *     A reference to this Builder instance
          */
@@ -238,13 +240,13 @@ public Builder div(Xhtml div) {
 
         /**
          * Build the {@link Narrative}
-         * 
+         *
          * <p>Required elements:
          * <ul>
          * <li>status</li>
          * <li>div</li>
          * </ul>
-         * 
+         *
          * @return
          *     An immutable object of type {@link Narrative}
          * @throws IllegalStateException

fhir-model/src/test/java/com/ibm/fhir/model/test/EmptyResourceTest.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -10,6 +10,7 @@
 import org.testng.annotations.Test;
 
 import com.ibm.fhir.model.resource.Patient;
+import com.ibm.fhir.model.type.Narrative;
 
 public class EmptyResourceTest {
     @Test
@@ -21,4 +22,9 @@ public void testEmptyPatient() {
             Assert.assertEquals(e.getMessage(), "global-1: All FHIR elements must have a @value or children");
         }
     }
+
+    @Test
+    public void testPatientWithEmptyNarrative() {
+        Patient.builder().text(Narrative.EMPTY).build();
+    }
 }

fhir-tools/src/main/java/com/ibm/fhir/tools/CodeGenerator.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -996,6 +996,10 @@ private void generateClass(JsonObject structureDefinition, List<String> paths, C
                 cb.field(mods("private", "static", "final"), "int", "MIN_VALUE", "0").newLine();
             }
 
+            if (isNarrative(structureDefinition)) {
+                cb.field(mods("public", "static", "final"), "Narrative", "EMPTY", "builder().status(NarrativeStatus.EMPTY).div(Xhtml.from(" + quote("Narrative text intentionally left empty") + ")).build()").newLine();
+            }
+
             if (isXhtml(structureDefinition)) {
                 cb.field(mods("private", "static", "final"), "java.lang.String", "DIV_OPEN", quote("<div xmlns=\\\"http://www.w3.org/1999/xhtml\\\">")).newLine();
                 cb.field(mods("private", "static", "final"), "java.lang.String", "DIV_CLOSE", quote("</div>")).newLine();
@@ -4275,6 +4279,10 @@ private boolean isUriSubtype(String className) {
         return uriSubtypeClassNames.contains(className);
     }
 
+    private boolean isNarrative(JsonObject structureDefinition) {
+        return "Narrative".equals(structureDefinition.getString("name"));
+    }
+
     private boolean isXhtml(JsonObject structureDefinition) {
         return "xhtml".equals(structureDefinition.getString("name"));
     }