class ProjectsLocationsDatasetsHl7V2StoresMessages extends Resource (View source)

The "messages" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $messages = $healthcareService->projects_locations_datasets_hl7V2Stores_messages;

Methods

create(string $parent, CreateMessageRequest $postBody, array $optParams = [])

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. (messages.create)

delete(string $name, array $optParams = [])

Deletes an HL7v2 message. (messages.delete)

get(string $name, array $optParams = [])

Gets an HL7v2 message. (messages.get)

ingest(string $parent, IngestMessageRequest $postBody, array $optParams = [])

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (ACK) message. If the method encounters an error, it returns a negative acknowledgment (NACK) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments. (messages.ingest)

listProjectsLocationsDatasetsHl7V2StoresMessages(string $parent, array $optParams = [])

Lists all the messages in the given HL7v2 store with support for filtering.

patch(string $name, Message $postBody, array $optParams = [])

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered.

Details

Message create(string $parent, CreateMessageRequest $postBody, array $optParams = [])

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. (messages.create)

Parameters

string $parent

Required. The name of the HL7v2 store this message belongs to.

CreateMessageRequest $postBody
array $optParams

Optional parameters.

Return Value

Message

Exceptions

Exception

HealthcareEmpty delete(string $name, array $optParams = [])

Deletes an HL7v2 message. (messages.delete)

Parameters

string $name

Required. The resource name of the HL7v2 message to delete.

array $optParams

Optional parameters.

Return Value

HealthcareEmpty

Exceptions

Exception

Message get(string $name, array $optParams = [])

Gets an HL7v2 message. (messages.get)

Parameters

string $name

Required. The resource name of the HL7v2 message to retrieve.

array $optParams

Optional parameters.

Return Value

Message

Exceptions

Exception

IngestMessageResponse ingest(string $parent, IngestMessageRequest $postBody, array $optParams = [])

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (ACK) message. If the method encounters an error, it returns a negative acknowledgment (NACK) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments. (messages.ingest)

Parameters

string $parent

Required. The name of the HL7v2 store this message belongs to.

IngestMessageRequest $postBody
array $optParams

Optional parameters.

Return Value

IngestMessageResponse

Exceptions

Exception

ListMessagesResponse listProjectsLocationsDatasetsHl7V2StoresMessages(string $parent, array $optParams = [])

Lists all the messages in the given HL7v2 store with support for filtering.

Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter. (messages.listProjectsLocationsDatasetsHl7V2StoresMessages)

Parameters

string $parent

Required. Name of the HL7v2 store to retrieve messages from.

array $optParams

Optional parameters.

Return Value

ListMessagesResponse

Exceptions

Exception

Message patch(string $name, Message $postBody, array $optParams = [])

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered.

Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated. (messages.patch)

Parameters

string $name

Output only. Resource name of the Message, of the form p rojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Store s/{hl7_v2_store_id}/messages/{message_id}.

Message $postBody
array $optParams

Optional parameters.

Return Value

Message

Exceptions

Exception