[Documentation] Specify version of HCLS API in Documentation (#27672)

* Created using Colaboratory * update documentation for ReadMe * update documentation for ReadMe * update documentation for ReadMe * Revert "update documentation for ReadMe" This reverts commit 7e2f6f3. * update documentation for ReadMe * Fix documentation by specifying client
apache · Jul 27, 2023 · 4d712eb · 4d712eb
1 parent d3ea232
commit 4d712eb
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/...io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/DicomIO.java b/...io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/DicomIO.java
@@ -154,7 +154,7 @@ static class FetchStudyMetadataFn extends DoFn<String, String> {
       FetchStudyMetadataFn() {}
 
       /**
-       * Instantiate the healthcare client.
+       * Instantiate the healthcare client (version v1).
        *
        * @throws IOException
        */

diff --git a/.../io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/FhirIO.java b/.../io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/FhirIO.java
@@ -584,7 +584,7 @@ static class ReadResourceFn extends DoFn<String, String> {
         ReadResourceFn() {}
 
         /**
-         * Instantiate healthcare client.
+         * Instantiate healthcare client (version v1).
          *
          * @throws IOException the io exception
          */
@@ -1460,7 +1460,7 @@ static class ExecuteBundlesFn extends DoFn<FhirBundleParameter, FhirBundleRespon
       }
 
       /**
-       * Initialize healthcare client.
+       * Initialize healthcare client (version v1).
        *
        * @throws IOException If the Healthcare client cannot be created.
        */
@@ -1964,7 +1964,7 @@ class SearchResourcesFn extends DoFn<FhirSearchParameter<T>, KV<String, JsonArra
       }
 
       /**
-       * Instantiate healthcare client.
+       * Instantiate healthcare client (version v1).
        *
        * @throws IOException the io exception
        */

diff --git a/...platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/FhirIOPatientEverything.java b/...platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/FhirIOPatientEverything.java
@@ -187,7 +187,7 @@ static class GetPatientEverythingFn extends DoFn<PatientEverythingParameter, Jso
     private HealthcareApiClient client;
 
     /**
-     * Instantiate healthcare client.
+     * Instantiate healthcare client (version v1).
      *
      * @throws IOException the io exception
      */

diff --git a/...io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/HL7v2IO.java b/...io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/HL7v2IO.java
@@ -349,7 +349,7 @@ public static class HL7v2MessageGetFn extends DoFn<String, HL7v2Message> {
         HL7v2MessageGetFn() {}
 
         /**
-         * Instantiate healthcare client.
+         * Instantiate healthcare client (version v1).
          *
          * @throws IOException the io exception
          */
@@ -471,7 +471,7 @@ public static class HL7v2MessageGetFn extends DoFn<HL7v2ReadParameter, HL7v2Read
         private HL7v2MessageClient client;
 
         /**
-         * Instantiate healthcare client.
+         * Instantiate healthcare client (version v1).
          *
          * @throws IOException the io exception
          */
@@ -547,7 +547,7 @@ private static class HL7v2MessageClient {
     private static final Logger LOG = LoggerFactory.getLogger(HL7v2MessageClient.class);
     private final HealthcareApiClient client;
 
-    /** Instantiates a new HL7v2MessageClient. */
+    /** Instantiates a new HL7v2MessageClient (HCLS API v1). */
     HL7v2MessageClient(HealthcareApiClient client) {
       this.client = client;
     }
@@ -666,7 +666,7 @@ static class ListHL7v2MessagesFn extends DoFn<String, HL7v2Message> {
     }
 
     /**
-     * Init client.
+     * Initialize client (v1).
      *
      * @throws IOException the io exception
      */
@@ -920,7 +920,7 @@ static class WriteHL7v2Fn extends DoFn<HL7v2Message, HealthcareIOError<HL7v2Mess
       }
 
       /**
-       * Init client.
+       * Initialize client (v1).
        *
        * @throws IOException the io exception
        */

diff --git a/...oud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/HealthcareApiClient.java b/...oud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/HealthcareApiClient.java
@@ -36,7 +36,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.joda.time.Instant;
 
-/** Defines a client that talks to the Cloud Healthcare API. */
+/** Defines a client that talks to the Cloud Healthcare API (version v1). */
 public interface HealthcareApiClient {
 
   /**
@@ -191,7 +191,7 @@ HttpBody searchFhirResource(
       throws IOException;
 
   /**
-   * Fhir get patient everythhing http body.
+   * Fhir get patient everything http body.
    *
    * @param resourceName the resource name, in format
    *     projects/{p}/locations/{l}/datasets/{d}/fhirStores/{f}/fhir/{resourceType}/{id}