more javadocs

src/main/java/org/mitre/synthea/export/flexporter/Actions.java

@@ -451,6 +451,12 @@ private static void keepResources(Bundle bundle, List<String> list) {
     }
   }
 
+  /**
+   * Shift all dates on all resources in the Bundle. Note this only modifies date/time-type fields
+   * on resources and cannot modify dates embedded within strings (for example, clinical notes).
+   * @param bundle FHIR Bundle to shift dates for
+   * @param amountString Amount to shift in ISO-8601 format, either Period or Duration
+   */
   private static void shiftDates(Bundle bundle, String amountString) {
     if (amountString == null) {
       return;
@@ -484,6 +490,14 @@ private static void shiftDates(Bundle bundle, String amountString) {
     }
   }
 
+  /**
+   * Filter the Bundle by date. If any resource has a date outside the provided range
+   * it will be filtered out.
+   * TODO: align this with export.years_of_history filter. "active" items outside range?
+   * @param bundle The Bundle to filter
+   * @param minDateStr Earliest/start value of the time range, in ISO-8601 format
+   * @param maxDateStr Latest/stop/end value of the time range, in ISO-8601 format
+   */
   private static void dateFilter(Bundle bundle, String minDateStr, String maxDateStr) {
     if (minDateStr == null && maxDateStr == null) {
       return;

src/main/java/org/mitre/synthea/export/flexporter/FieldWrapper.java

@@ -379,6 +379,12 @@ public ReferenceFieldWrapper(Class<? extends Resource> clazz, String fieldName)
       super(clazz, fieldName);
     }
 
+    /**
+     * Get a single reference from the field this FieldWrapper represents on the given resource,
+     * as a string.
+     * @param resource Resource to get the value from
+     * @return Reference as string, ex. "Patient/123" or "urn:uuid:98d1c..."
+     */
     public String getReference(Resource resource) {
       IBase referenceObject = getSingle(resource);
       if (!(referenceObject instanceof Reference)) {
@@ -388,6 +394,12 @@ public String getReference(Resource resource) {
       return ref.getReference();
     }
 
+    /**
+     * Get all references from the field this FieldWrapper represents on the given resource,
+     * as a list of strings.
+     * @param resource Resource to get the value from
+     * @return References as strings, ex. "Patient/123" or "urn:uuid:98d1c..."
+     */
     public List<String> getReferences(Resource resource) {
       List<IBase> referenceObjects = getAll(resource);