Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 10 commits into from
Jul 27, 2023
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ static class FetchStudyMetadataFn extends DoFn<String, String> {
FetchStudyMetadataFn() {}

/**
* Instantiate the healthcare client.
* Instantiate the healthcare client (version v1).
*
* @throws IOException
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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;
}
Expand Down Expand Up @@ -666,7 +666,7 @@ static class ListHL7v2MessagesFn extends DoFn<String, HL7v2Message> {
}

/**
* Init client.
* Initialize client (v1).
*
* @throws IOException the io exception
*/
Expand Down Expand Up @@ -920,7 +920,7 @@ static class WriteHL7v2Fn extends DoFn<HL7v2Message, HealthcareIOError<HL7v2Mess
}

/**
* Init client.
* Initialize client (v1).
*
* @throws IOException the io exception
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

/**
Expand Down Expand Up @@ -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}
Expand Down