Merge pull request #110 from MeasureAuthoringTool/develop

Release 0.3.1

.github/workflows/maven-ci.yml

@@ -7,10 +7,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 16
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: '16'
+          java-version: '17'
           distribution: 'adopt'
       - name: Build with Maven
         run: mvn --batch-mode --update-snapshots verify
@@ -24,11 +24,11 @@ jobs:
     if: github.ref == 'refs/heads/develop'
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 16
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'adopt'
-          java-version: '16'
+          java-version: '17'
 
       - name: Extract project version
         run: echo ::set-output name=version::$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>gov.cms.madie</groupId>
   <artifactId>madie-java-models</artifactId>
-  <version>0.2.24</version>
+  <version>0.3.1</version>
 
   <name>madie-java-models</name>
   <description>Java based models for MADiE microservices</description>
@@ -41,15 +41,20 @@
       <version>1.18.22</version>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter</artifactId>
+      <version>3.0.2</version>
+    </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-validation</artifactId>
-      <version>2.6.6</version>
+      <version>2.6.14</version>
     </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-data-mongodb</artifactId>
-      <version>2.6.6</version>
+      <version>3.0.2</version>
     </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>

src/main/java/gov/cms/madie/models/common/ActionType.java

@@ -4,7 +4,9 @@ public enum ActionType {
   CREATED,
   VERSIONED_MAJOR,
   VERSIONED_MINOR,
+  VERSIONED_REVISIONNUMBER,
   DELETED,
   IMPORTED,
-  UPDATED
+  UPDATED,
+  DRAFTED
 }

src/main/java/gov/cms/madie/models/common/EndorserOrganization.java

@@ -0,0 +1,22 @@
+package gov.cms.madie.models.common;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.mongodb.core.mapping.Document;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Document(collection = "endorserOrganization")
+public class EndorserOrganization {
+
+    @Id
+    private String id;
+
+    private String endorserOrganization;
+
+}

src/main/java/gov/cms/madie/models/common/Organization.java

@@ -20,4 +20,6 @@ public class Organization {
 
   @Indexed(unique = true)
   private String oid;
+
+  private String url;
 }

src/main/java/gov/cms/madie/models/common/ProgramUseContext.java

@@ -0,0 +1,16 @@
+package gov.cms.madie.models.common;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder(toBuilder = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class ProgramUseContext {
+  private String codeSystem;
+  private String code;
+  private String display;
+}

src/main/java/gov/cms/madie/models/library/Version.java → src/main/java/gov/cms/madie/models/common/Version.java

@@ -1,4 +1,4 @@
-package gov.cms.madie.models.library;
+package gov.cms.madie.models.common;
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;

src/main/java/gov/cms/madie/models/library/CqlLibrary.java

@@ -6,6 +6,8 @@
 import gov.cms.madie.models.validators.EnumValidator;
 import gov.cms.madie.models.utils.VersionJsonSerializer;
 import gov.cms.madie.models.common.ModelType;
+import gov.cms.madie.models.common.ProgramUseContext;
+import gov.cms.madie.models.common.Version;
 
 import java.time.Instant;
 import javax.validation.GroupSequence;
@@ -70,6 +72,7 @@ public class CqlLibrary {
   private String publisher;
   private String description;
   private boolean experimental;
+  private ProgramUseContext programUseContext;
 
   @GroupSequence({
     CqlLibrary.ValidationOrder1.class,

src/main/java/gov/cms/madie/models/measure/Endorsement.java

@@ -1,16 +1,20 @@
 package gov.cms.madie.models.measure;
 
-import org.springframework.data.annotation.Id;
-
+import gov.cms.madie.models.validators.RequiredOnSelect;
+import javax.validation.constraints.Pattern;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 
 @Data
 @SuperBuilder(toBuilder = true)
 @NoArgsConstructor
+@RequiredOnSelect(selectedField = "endorser", requiredField = "endorsementId", message = "EndorsementId is required when endorser is not null")
 public class Endorsement {
-	@Id private String id;
-	private String endorser;
-	private String endorsementId;
+
+    private String endorser;
+    private String endorserSystemId;
+    @Pattern(
+        regexp = "^[A-Za-z0-9]*$", message = "Endorsement Id is invalid")
+    private String endorsementId;
 }

src/main/java/gov/cms/madie/models/measure/Group.java

@@ -34,6 +34,7 @@ public class Group implements GroupScoringPopulation {
       groups = {Measure.ValidationOrder5.class})
   private String scoring;
 
+  @Valid
   private List<Population> populations;
 
   private List<MeasureObservation> measureObservations;

src/main/java/gov/cms/madie/models/measure/Measure.java

@@ -3,16 +3,26 @@
 import java.time.Instant;
 import java.util.Date;
 import java.util.List;
+import java.util.Set;
 import javax.validation.GroupSequence;
 import javax.validation.Valid;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Pattern;
 import javax.validation.groups.Default;
+
+import gov.cms.madie.models.common.ProgramUseContext;
+import lombok.Singular;
 import org.hibernate.validator.constraints.Length;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.annotation.Transient;
 import org.springframework.data.mongodb.core.index.Indexed;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+
 import gov.cms.madie.models.common.ModelType;
+import gov.cms.madie.models.common.Version;
+import gov.cms.madie.models.utils.VersionJsonSerializer;
 import gov.cms.madie.models.validators.EnumValidator;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -26,8 +36,16 @@ public class Measure extends ResourceAcl {
   @Id private String id;
 
   private String measureHumanReadableId;
+
+  @NotBlank(
+    groups = {ValidationOrder1.class},
+    message = "Measure Set ID is required.")
   private String measureSetId;
-  private String version;
+
+  @JsonSerialize(using = VersionJsonSerializer.VersionSerializer.class)
+  @JsonDeserialize(using = VersionJsonSerializer.VersionDeserializer.class)
+  private Version version;
+  //temp for MAT-5191
   private String revisionNumber;
   private String state;
 
@@ -76,6 +94,8 @@ public class Measure extends ResourceAcl {
   // TODO: determine if theres a way to set this from backend or if we should always trust user
   // input for this field
   private boolean cqlErrors;
+  @Singular
+  private Set<MeasureErrorType> errors;
   private String cql;
   private String elmJson;
   @Transient private String elmXml;
@@ -87,20 +107,27 @@ public class Measure extends ResourceAcl {
   private String lastModifiedBy;
   private Date measurementPeriodStart;
   private Date measurementPeriodEnd;
+  @Singular("sde")
+  private List<SupplementalData> supplementalData;
+  private List<RiskAdjustment> riskAdjustments;
+  private ProgramUseContext programUseContext;
 
   @EnumValidator(
       enumClass = ModelType.class,
       message = "MADiE was unable to complete your request, please try again.",
       groups = {ValidationOrder5.class})
   private String model;
 
+  @Valid
   private MeasureMetaData measureMetaData = new MeasureMetaData();
 
   @NotBlank(
       groups = {ValidationOrder1.class},
       message = "Version ID is required.")
   private String versionId;
   private String cmsId;
+
+  private ReviewMetaData reviewMetaData = new ReviewMetaData();
 
   @GroupSequence({
     Measure.ValidationOrder1.class,

src/main/java/gov/cms/madie/models/measure/MeasureErrorType.java

@@ -0,0 +1,10 @@
+package gov.cms.madie.models.measure;
+
+public enum MeasureErrorType {
+  MISSING_ELM,
+  ERRORS_ELM_JSON,
+  MISMATCH_CQL_POPULATION_RETURN_TYPES,
+  MISMATCH_CQL_RISK_ADJUSTMENT,
+  MISMATCH_CQL_SUPPLEMENTAL_DATA,
+  INVALID_TERMINOLOGY
+}

src/main/java/gov/cms/madie/models/measure/MeasureMetaData.java

@@ -1,28 +1,35 @@
 package gov.cms.madie.models.measure;
 
+import gov.cms.madie.models.common.Organization;
+import javax.validation.Valid;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import java.util.List;
 
-@NoArgsConstructor
 @Data
+@Builder(toBuilder=true)
+@NoArgsConstructor
+@AllArgsConstructor
 public class MeasureMetaData {
-  private String steward;
-  private List<String> developers;
+  private Organization steward;
+  private List<Organization> developers;
   private String description;
   private String copyright;
   private String disclaimer;
   private String rationale;
   private String guidance;
   private String clinicalRecommendation;
-  
+
   private boolean draft;
   private List<Reference> references;
+  @Valid
   private List<Endorsement> endorsements;
   private String riskAdjustment;
   private String definition;
   private boolean experimental;
   private String transmissionFormat;
   private String supplementalDataElements;
-  
+
 }

src/main/java/gov/cms/madie/models/measure/MeasureObservation.java

@@ -20,6 +20,7 @@ public class MeasureObservation {
       groups = {Measure.ValidationOrder5.class}
   )
   private String definition;
+  private String description;
   private String criteriaReference;
   @NotNull(
       message = "Aggregate Method is required.",

src/main/java/gov/cms/madie/models/measure/Population.java

@@ -4,6 +4,9 @@
 import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
+
+import javax.validation.constraints.NotBlank;
+
 import org.springframework.data.annotation.Id;
 
 @Data
@@ -12,6 +15,7 @@
 @AllArgsConstructor
 public class Population {
   @Id
+  @NotBlank(message = "Population ID is required.")
   private String id;
   private PopulationType name;
   private String definition;

src/main/java/gov/cms/madie/models/measure/ReviewMetaData.java

@@ -0,0 +1,17 @@
+package gov.cms.madie.models.measure;
+
+import java.time.Instant;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder(toBuilder=true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class ReviewMetaData {
+  private Instant approvalDate;
+  private Instant lastReviewDate;
+}

src/main/java/gov/cms/madie/models/measure/RiskAdjustment.java

@@ -0,0 +1,15 @@
+package gov.cms.madie.models.measure;
+
+import lombok.Data;
+
+@Data
+public class RiskAdjustment extends SupplementalData {
+
+    public RiskAdjustment() {
+        super();
+    }
+
+    public RiskAdjustment(String definition, String description) {
+        super(definition, description);
+    }
+}

src/main/java/gov/cms/madie/models/measure/SupplementalData.java

@@ -0,0 +1,18 @@
+package gov.cms.madie.models.measure;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder(toBuilder = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class SupplementalData {
+
+    private String definition;
+
+    private String description;
+
+}