issue #2145 - add MaturityLevel javadoc and annotation to model classes

Signed-off-by: Lee Surprenant <lmsurpre@us.ibm.com>
LinuxForHealth · Mar 25, 2021 · f263919 · f263919
1 parent ab370a6
commit f263919
Show file tree

Hide file tree

Showing 466 changed files with 1,175 additions and 499 deletions.
diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/annotation/MaturityLevel.java b/fhir-model/src/main/java/com/ibm/fhir/model/annotation/MaturityLevel.java
@@ -0,0 +1,17 @@
+/*
+ * (C) Copyright IBM Corp. 2021
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package com.ibm.fhir.model.annotation;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * @see <a href="https://confluence.hl7.org/display/FHIR/FHIR+Maturity+Model">https://confluence.hl7.org/display/FHIR/FHIR+Maturity+Model</a>
+ */
+@Retention(RetentionPolicy.RUNTIME)
+public @interface MaturityLevel {
+    int value();
+}
diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/parser/FHIRJsonParser.java b/fhir-model/src/main/java/com/ibm/fhir/model/parser/FHIRJsonParser.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/parser/FHIRXMLParser.java b/fhir-model/src/main/java/com/ibm/fhir/model/parser/FHIRXMLParser.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/Account.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/Account.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -15,6 +15,7 @@
 import javax.annotation.Generated;
 
 import com.ibm.fhir.model.annotation.Binding;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -39,7 +40,10 @@
 /**
  * A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges 
  * for a patient, cost centers, etc.
+ * 
+ * <p>Maturity level: FMM2 (Trial Use)
  */
+@MaturityLevel(2)
 @Generated("com.ibm.fhir.tools.CodeGenerator")
 public class Account extends DomainResource {
     @Summary

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/ActivityDefinition.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/ActivityDefinition.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -17,6 +17,7 @@
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Choice;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -59,7 +60,10 @@
 /**
  * This resource allows for the definition of some activity to be performed, independent of a particular patient, 
  * practitioner, or other performance context.
+ * 
+ * <p>Maturity level: FMM2 (Trial Use)
  */
+@MaturityLevel(2)
 @Constraint(
     id = "adf-0",
     level = "Warning",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/AdverseEvent.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/AdverseEvent.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -16,6 +16,7 @@
 
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -39,7 +40,10 @@
  * Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, 
  * a research study or other healthcare setting factors that requires additional monitoring, treatment, or 
  * hospitalization, or that results in death.
+ * 
+ * <p>Maturity level: FMM0 (Draft)
  */
+@MaturityLevel(0)
 @Constraint(
     id = "adverseEvent-0",
     level = "Warning",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/AllergyIntolerance.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/AllergyIntolerance.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -17,6 +17,7 @@
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Choice;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -47,7 +48,10 @@
 /**
  * Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure 
  * to a substance.
+ * 
+ * <p>Maturity level: FMM3 (Trial Use)
  */
+@MaturityLevel(3)
 @Constraint(
     id = "ait-1",
     level = "Rule",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/Appointment.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/Appointment.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -16,6 +16,7 @@
 
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -44,7 +45,10 @@
 /**
  * A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific 
  * date/time. This may result in one or more Encounter(s).
+ * 
+ * <p>Maturity level: FMM3 (Trial Use)
  */
+@MaturityLevel(3)
 @Constraint(
     id = "app-1",
     level = "Rule",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/AppointmentResponse.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/AppointmentResponse.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -16,6 +16,7 @@
 
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -36,7 +37,10 @@
 
 /**
  * A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
+ * 
+ * <p>Maturity level: FMM3 (Trial Use)
  */
+@MaturityLevel(3)
 @Constraint(
     id = "apr-1",
     level = "Rule",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/AuditEvent.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/AuditEvent.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -17,6 +17,7 @@
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Choice;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -45,7 +46,10 @@
 /**
  * A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion 
  * attempts and monitoring for inappropriate usage.
+ * 
+ * <p>Maturity level: FMM3 (Trial Use)
  */
+@MaturityLevel(3)
 @Constraint(
     id = "sev-1",
     level = "Rule",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/Basic.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/Basic.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -15,6 +15,7 @@
 import javax.annotation.Generated;
 
 import com.ibm.fhir.model.annotation.Binding;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -34,7 +35,10 @@
 /**
  * Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing 
  * resource, and custom resources not appropriate for inclusion in the FHIR specification.
+ * 
+ * <p>Maturity level: FMM1 (Trial Use)
  */
+@MaturityLevel(1)
 @Generated("com.ibm.fhir.tools.CodeGenerator")
 public class Basic extends DomainResource {
     @Summary

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/Binary.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/Binary.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -11,6 +11,7 @@
 import javax.annotation.Generated;
 
 import com.ibm.fhir.model.annotation.Binding;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
 import com.ibm.fhir.model.type.Base64Binary;
@@ -25,7 +26,10 @@
 /**
  * A resource that represents the data of a single raw artifact as digital content accessible in its native format. A 
  * Binary resource can contain any content, whether text, image, pdf, zip archive, etc.
+ * 
+ * <p>Maturity level: FMM5 (Trial Use)
  */
+@MaturityLevel(5)
 @Generated("com.ibm.fhir.tools.CodeGenerator")
 public class Binary extends Resource {
     @Summary

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/BiologicallyDerivedProduct.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/BiologicallyDerivedProduct.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -15,6 +15,7 @@
 
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Choice;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Summary;
 import com.ibm.fhir.model.type.BackboneElement;
@@ -42,7 +43,10 @@
 /**
  * A material substance originating from a biological entity intended to be transplanted or infused
  * into another (possibly the same) biological entity.
+ * 
+ * <p>Maturity level: FMM0 (Draft)
  */
+@MaturityLevel(0)
 @Generated("com.ibm.fhir.tools.CodeGenerator")
 public class BiologicallyDerivedProduct extends DomainResource {
     @Summary

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/BodyStructure.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/BodyStructure.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -15,6 +15,7 @@
 import javax.annotation.Generated;
 
 import com.ibm.fhir.model.annotation.Binding;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -36,7 +37,10 @@
 /**
  * Record details about an anatomical structure. This resource may be used when a coded concept does not provide the 
  * necessary detail needed for the use case.
+ * 
+ * <p>Maturity level: FMM1 (Trial Use)
  */
+@MaturityLevel(1)
 @Generated("com.ibm.fhir.tools.CodeGenerator")
 public class BodyStructure extends DomainResource {
     @Summary

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/Bundle.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/Bundle.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -16,6 +16,7 @@
 
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
 import com.ibm.fhir.model.type.BackboneElement;
@@ -38,7 +39,10 @@
 
 /**
  * A container for a collection of resources.
+ * 
+ * <p>Maturity level: FMM5 (Trial Use)
  */
+@MaturityLevel(5)
 @Constraint(
     id = "bdl-1",
     level = "Rule",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/CapabilityStatement.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/CapabilityStatement.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -16,6 +16,7 @@
 
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -59,7 +60,10 @@
  * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR 
  * that may be used as a statement of actual server functionality or a statement of required or desired server 
  * implementation.
+ * 
+ * <p>Maturity level: FMM5 (Trial Use)
  */
+@MaturityLevel(5)
 @Constraint(
     id = "cpb-0",
     level = "Warning",

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/CarePlan.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/CarePlan.java
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2019, 2020
+ * (C) Copyright IBM Corp. 2019, 2021
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -17,6 +17,7 @@
 import com.ibm.fhir.model.annotation.Binding;
 import com.ibm.fhir.model.annotation.Choice;
 import com.ibm.fhir.model.annotation.Constraint;
+import com.ibm.fhir.model.annotation.MaturityLevel;
 import com.ibm.fhir.model.annotation.ReferenceTarget;
 import com.ibm.fhir.model.annotation.Required;
 import com.ibm.fhir.model.annotation.Summary;
@@ -49,7 +50,10 @@
 /**
  * Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or 
  * community for a period of time, possibly limited to care for a specific condition or set of conditions.
+ * 
+ * <p>Maturity level: FMM2 (Trial Use)
  */
+@MaturityLevel(2)
 @Constraint(
     id = "cpl-3",
     level = "Rule",