org.apache.beam.sdk.io.gcp.healthcare

Interface HealthcareApiClient

All Known Implementing Classes:

HttpHealthcareApiClient

public interface HealthcareApiClient

Defines a client that talks to the Cloud Healthcare API.

Method Summary

Modifier and Type	Method and Description
com.google.api.services.healthcare.v1.model.DicomStore	createDicomStore(java.lang.String dataset, java.lang.String name)
com.google.api.services.healthcare.v1.model.DicomStore	createDicomStore(java.lang.String dataset, java.lang.String name, java.lang.String pubsubTopic)
com.google.api.services.healthcare.v1.model.FhirStore	createFhirStore(java.lang.String dataset, java.lang.String name, java.lang.String version)
com.google.api.services.healthcare.v1.model.FhirStore	createFhirStore(java.lang.String dataset, java.lang.String name, java.lang.String version, java.lang.String pubsubTopic)
com.google.api.services.healthcare.v1.model.Message	createHL7v2Message(java.lang.String hl7v2Store, com.google.api.services.healthcare.v1.model.Message msg) Create hl 7 v 2 message message.
com.google.api.services.healthcare.v1.model.Hl7V2Store	createHL7v2Store(java.lang.String dataset, java.lang.String name) Create hl 7 v 2 store hl 7 v 2 store.
com.google.api.services.healthcare.v1.model.Operation	deidentifyFhirStore(java.lang.String sourceFhirStore, java.lang.String destinationFhirStore, com.google.api.services.healthcare.v1.model.DeidentifyConfig deidConfig)
com.google.api.services.healthcare.v1.model.Empty	deleteDicomStore(java.lang.String name)
com.google.api.services.healthcare.v1.model.Empty	deleteFhirStore(java.lang.String store)
com.google.api.services.healthcare.v1.model.Empty	deleteHL7v2Message(java.lang.String msgName) Delete hl 7 v 2 message empty.
com.google.api.services.healthcare.v1.model.Empty	deleteHL7v2Store(java.lang.String store) Delete hl 7 v 2 store empty.
com.google.api.services.healthcare.v1.model.HttpBody	executeFhirBundle(java.lang.String fhirStore, java.lang.String bundle) Execute fhir bundle http body.
com.google.api.services.healthcare.v1.model.Operation	exportFhirResourceToGcs(java.lang.String fhirStore, java.lang.String gcsDestinationPrefix)
Instant	getEarliestHL7v2SendTime(java.lang.String hl7v2Store, @Nullable java.lang.String filter) Gets earliest hl 7 v 2 send time.
com.google.api.services.healthcare.v1.model.Message	getHL7v2Message(java.lang.String msgName) Fetches an Hl7v2 message by its name from a Hl7v2 store.
com.google.api.services.healthcare.v1.model.Hl7V2Store	getHL7v2Store(java.lang.String storeName) Gets HL7v2 store.
Instant	getLatestHL7v2SendTime(java.lang.String hl7v2Store, @Nullable java.lang.String filter)
com.google.api.services.healthcare.v1.model.HttpBody	getPatientEverything(java.lang.String resourceName, @Nullable java.util.Map<java.lang.String,java.lang.Object> filters, java.lang.String pageToken) Fhir get patient everythhing http body.
com.google.api.services.healthcare.v1.model.Operation	importFhirResource(java.lang.String fhirStore, java.lang.String gcsSourcePath, @Nullable java.lang.String contentStructure)
com.google.api.services.healthcare.v1.model.IngestMessageResponse	ingestHL7v2Message(java.lang.String hl7v2Store, com.google.api.services.healthcare.v1.model.Message msg) Ingest hl 7 v 2 message ingest message response.
java.util.List<com.google.api.services.healthcare.v1.model.FhirStore>	listAllFhirStores(java.lang.String dataset) List all FHIR stores in a dataset.
com.google.api.services.healthcare.v1.model.ListMessagesResponse	makeHL7v2ListRequest(java.lang.String hl7v2Store, @Nullable java.lang.String filter, @Nullable java.lang.String orderBy, @Nullable java.lang.String pageToken) Make hl 7 v 2 list request list messages response.
com.google.api.services.healthcare.v1.model.ListMessagesResponse	makeSendTimeBoundHL7v2ListRequest(java.lang.String hl7v2Store, Instant start, @Nullable Instant end, @Nullable java.lang.String otherFilter, @Nullable java.lang.String orderBy, @Nullable java.lang.String pageToken) Make send time bound hl 7 v 2 list request.
com.google.api.services.healthcare.v1.model.Operation	pollOperation(com.google.api.services.healthcare.v1.model.Operation operation, java.lang.Long sleepMs)
com.google.api.services.healthcare.v1.model.HttpBody	readFhirResource(java.lang.String resourceName) Read fhir resource http body.
java.lang.String	retrieveDicomStudyMetadata(java.lang.String dicomWebPath)
com.google.api.services.healthcare.v1.model.HttpBody	searchFhirResource(java.lang.String fhirStore, java.lang.String resourceType, @Nullable java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String pageToken) Search fhir resource http body.
com.google.api.services.healthcare.v1.model.Empty	uploadToDicomStore(java.lang.String webPath, java.lang.String filePath)

Method Detail

getHL7v2Message

com.google.api.services.healthcare.v1.model.Message getHL7v2Message(java.lang.String msgName)
                                                             throws java.io.IOException,
                                                                    java.text.ParseException

Fetches an Hl7v2 message by its name from a Hl7v2 store.

Parameters:

msgName - the msg name

Returns:

HL7v2 message

Throws:

java.io.IOException - the io exception

java.text.ParseException - the parse exception

deleteHL7v2Message

com.google.api.services.healthcare.v1.model.Empty deleteHL7v2Message(java.lang.String msgName)
                                                              throws java.io.IOException

Delete hl 7 v 2 message empty.

Parameters:

msgName - the msg name

Returns:

the empty

Throws:

java.io.IOException - the io exception

getHL7v2Store

com.google.api.services.healthcare.v1.model.Hl7V2Store getHL7v2Store(java.lang.String storeName)
                                                              throws java.io.IOException

Gets HL7v2 store.

Parameters:

storeName - the store name

Returns:

the HL7v2 store

Throws:

java.io.IOException - the io exception

getEarliestHL7v2SendTime

Instant getEarliestHL7v2SendTime(java.lang.String hl7v2Store,
                                 @Nullable java.lang.String filter)
                          throws java.io.IOException

Gets earliest hl 7 v 2 send time.

Parameters:

hl7v2Store - the hl 7 v 2 store

filter - the filter

Returns:

the earliest hl 7 v 2 send time

Throws:

java.io.IOException - the io exception

getLatestHL7v2SendTime

Instant getLatestHL7v2SendTime(java.lang.String hl7v2Store,
                               @Nullable java.lang.String filter)
                        throws java.io.IOException

Throws:

java.io.IOException

makeSendTimeBoundHL7v2ListRequest

com.google.api.services.healthcare.v1.model.ListMessagesResponse makeSendTimeBoundHL7v2ListRequest(java.lang.String hl7v2Store,
                                                                                                   Instant start,
                                                                                                   @Nullable Instant end,
                                                                                                   @Nullable java.lang.String otherFilter,
                                                                                                   @Nullable java.lang.String orderBy,
                                                                                                   @Nullable java.lang.String pageToken)
                                                                                            throws java.io.IOException

Make send time bound hl 7 v 2 list request.

Parameters:

hl7v2Store - the hl 7 v 2 store

start - the start

end - the end

otherFilter - the other filter

orderBy - the order by

pageToken - the page token

Returns:

the list messages response

Throws:

java.io.IOException - the io exception

makeHL7v2ListRequest

com.google.api.services.healthcare.v1.model.ListMessagesResponse makeHL7v2ListRequest(java.lang.String hl7v2Store,
                                                                                      @Nullable java.lang.String filter,
                                                                                      @Nullable java.lang.String orderBy,
                                                                                      @Nullable java.lang.String pageToken)
                                                                               throws java.io.IOException

Make hl 7 v 2 list request list messages response.

Parameters:

hl7v2Store - the hl 7 v 2 store

filter - the filter

orderBy - the order by

pageToken - the page token

Returns:

the list messages response

Throws:

java.io.IOException - the io exception

ingestHL7v2Message

com.google.api.services.healthcare.v1.model.IngestMessageResponse ingestHL7v2Message(java.lang.String hl7v2Store,
                                                                                     com.google.api.services.healthcare.v1.model.Message msg)
                                                                              throws java.io.IOException

Ingest hl 7 v 2 message ingest message response.

Parameters:

hl7v2Store - the hl 7 v 2 store

msg - the msg

Returns:

the ingest message response

Throws:

java.io.IOException - the io exception

createHL7v2Message

com.google.api.services.healthcare.v1.model.Message createHL7v2Message(java.lang.String hl7v2Store,
                                                                       com.google.api.services.healthcare.v1.model.Message msg)
                                                                throws java.io.IOException

Create hl 7 v 2 message message.

Parameters:

hl7v2Store - the hl 7 v 2 store

msg - the msg

Returns:

the message

Throws:

java.io.IOException - the io exception

importFhirResource

com.google.api.services.healthcare.v1.model.Operation importFhirResource(java.lang.String fhirStore,
                                                                         java.lang.String gcsSourcePath,
                                                                         @Nullable java.lang.String contentStructure)
                                                                  throws java.io.IOException

Throws:

java.io.IOException

exportFhirResourceToGcs

com.google.api.services.healthcare.v1.model.Operation exportFhirResourceToGcs(java.lang.String fhirStore,
                                                                              java.lang.String gcsDestinationPrefix)
                                                                       throws java.io.IOException

Throws:

java.io.IOException

deidentifyFhirStore

com.google.api.services.healthcare.v1.model.Operation deidentifyFhirStore(java.lang.String sourceFhirStore,
                                                                          java.lang.String destinationFhirStore,
                                                                          com.google.api.services.healthcare.v1.model.DeidentifyConfig deidConfig)
                                                                   throws java.io.IOException

Throws:

java.io.IOException

pollOperation

com.google.api.services.healthcare.v1.model.Operation pollOperation(com.google.api.services.healthcare.v1.model.Operation operation,
                                                                    java.lang.Long sleepMs)
                                                             throws java.lang.InterruptedException,
                                                                    java.io.IOException

Throws:

java.lang.InterruptedException

java.io.IOException

executeFhirBundle

com.google.api.services.healthcare.v1.model.HttpBody executeFhirBundle(java.lang.String fhirStore,
                                                                       java.lang.String bundle)
                                                                throws java.io.IOException,
                                                                       HttpHealthcareApiClient.HealthcareHttpException

Execute fhir bundle http body.

Parameters:

fhirStore - the fhir store

bundle - the bundle

Returns:

the http body

Throws:

java.io.IOException - the io exception

HttpHealthcareApiClient.HealthcareHttpException

readFhirResource

com.google.api.services.healthcare.v1.model.HttpBody readFhirResource(java.lang.String resourceName)
                                                               throws java.io.IOException

Read fhir resource http body.

Parameters:

resourceName - the resource name, in format projects/{p}/locations/{l}/datasets/{d}/fhirStores/{f}/fhir/{resourceType}/{id}

Returns:

the http body

Throws:

java.io.IOException - the io exception

searchFhirResource

com.google.api.services.healthcare.v1.model.HttpBody searchFhirResource(java.lang.String fhirStore,
                                                                        java.lang.String resourceType,
                                                                        @Nullable java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                        java.lang.String pageToken)
                                                                 throws java.io.IOException

Search fhir resource http body.

Parameters:

fhirStore - the fhir store

resourceType - the resource type

parameters - the parameters

Returns:

the http body

Throws:

java.io.IOException

getPatientEverything

com.google.api.services.healthcare.v1.model.HttpBody getPatientEverything(java.lang.String resourceName,
                                                                          @Nullable java.util.Map<java.lang.String,java.lang.Object> filters,
                                                                          java.lang.String pageToken)
                                                                   throws java.io.IOException

Fhir get patient everythhing http body.

Parameters:

resourceName - the resource name, in format projects/{p}/locations/{l}/datasets/{d}/fhirStores/{f}/fhir/{resourceType}/{id}

filters - optional request filters

Returns:

the http body

Throws:

java.io.IOException

createHL7v2Store

com.google.api.services.healthcare.v1.model.Hl7V2Store createHL7v2Store(java.lang.String dataset,
                                                                        java.lang.String name)
                                                                 throws java.io.IOException

Create hl 7 v 2 store hl 7 v 2 store.

Parameters:

dataset - the dataset

name - the name

Returns:

the hl 7 v 2 store

Throws:

java.io.IOException - the io exception

createFhirStore

com.google.api.services.healthcare.v1.model.FhirStore createFhirStore(java.lang.String dataset,
                                                                      java.lang.String name,
                                                                      java.lang.String version,
                                                                      java.lang.String pubsubTopic)
                                                               throws java.io.IOException

Throws:

java.io.IOException

createFhirStore

com.google.api.services.healthcare.v1.model.FhirStore createFhirStore(java.lang.String dataset,
                                                                      java.lang.String name,
                                                                      java.lang.String version)
                                                               throws java.io.IOException

Throws:

java.io.IOException

listAllFhirStores

java.util.List<com.google.api.services.healthcare.v1.model.FhirStore> listAllFhirStores(java.lang.String dataset)
                                                                                 throws java.io.IOException

List all FHIR stores in a dataset.

Parameters:

dataset - the dataset, in the format: projects/project_id/locations/location_id/datasets/dataset_id

Returns:

a list of FhirStore

Throws:

java.io.IOException

deleteHL7v2Store

com.google.api.services.healthcare.v1.model.Empty deleteHL7v2Store(java.lang.String store)
                                                            throws java.io.IOException

Delete hl 7 v 2 store empty.

Parameters:

store - the store

Returns:

the empty

Throws:

java.io.IOException - the io exception

deleteFhirStore

com.google.api.services.healthcare.v1.model.Empty deleteFhirStore(java.lang.String store)
                                                           throws java.io.IOException

Throws:

java.io.IOException

retrieveDicomStudyMetadata

java.lang.String retrieveDicomStudyMetadata(java.lang.String dicomWebPath)
                                     throws java.io.IOException

Throws:

java.io.IOException

createDicomStore

com.google.api.services.healthcare.v1.model.DicomStore createDicomStore(java.lang.String dataset,
                                                                        java.lang.String name)
                                                                 throws java.io.IOException

Throws:

java.io.IOException

createDicomStore

com.google.api.services.healthcare.v1.model.DicomStore createDicomStore(java.lang.String dataset,
                                                                        java.lang.String name,
                                                                        java.lang.String pubsubTopic)
                                                                 throws java.io.IOException

Throws:

java.io.IOException

deleteDicomStore

com.google.api.services.healthcare.v1.model.Empty deleteDicomStore(java.lang.String name)
                                                            throws java.io.IOException

Throws:

java.io.IOException

uploadToDicomStore

com.google.api.services.healthcare.v1.model.Empty uploadToDicomStore(java.lang.String webPath,
                                                                     java.lang.String filePath)
                                                              throws java.io.IOException,
                                                                     java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException