Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsHl7V2StoresMessages extends Google_Service_Resource
in package

The "messages" collection of methods.

Typical usage is: $healthcareService = new Google_Service_CloudHealthcare(...); $messages = $healthcareService->messages;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_CloudHealthcare_Message
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. (messages.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudHealthcare_HealthcareEmpty
Deletes an HL7v2 message. (messages.delete)
get()  : Google_Service_CloudHealthcare_Message
Gets an HL7v2 message. (messages.get)
ingest()  : Google_Service_CloudHealthcare_IngestMessageResponse
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. This method also generates a response containing an HL7v2 acknowledgement (`ACK`) message when successful or a negative acknowledgement (`NACK`) message in case of error, suitable for replying to HL7v2 interface systems that expect these acknowledgements. (messages.ingest)
listProjectsLocationsDatasetsHl7V2StoresMessages()  : Google_Service_CloudHealthcare_ListMessagesResponse
Lists all the messages in the given HL7v2 store with support for filtering.
patch()  : Google_Service_CloudHealthcare_Message
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.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

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

public create(string $parent, Google_Service_CloudHealthcare_CreateMessageRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Message
Parameters
$parent : string

The name of the dataset this message belongs to.

$postBody : Google_Service_CloudHealthcare_CreateMessageRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_Message —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Gets an HL7v2 message. (messages.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Message
Parameters
$name : string

The resource name of the HL7v2 message to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string view Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.

Return values
Google_Service_CloudHealthcare_Message —

ingest()

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. This method also generates a response containing an HL7v2 acknowledgement (`ACK`) message when successful or a negative acknowledgement (`NACK`) message in case of error, suitable for replying to HL7v2 interface systems that expect these acknowledgements. (messages.ingest)

public ingest(string $parent, Google_Service_CloudHealthcare_IngestMessageRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_IngestMessageResponse
Parameters
$parent : string

The name of the HL7v2 store this message belongs to.

$postBody : Google_Service_CloudHealthcare_IngestMessageRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudHealthcare_IngestMessageResponse —

listProjectsLocationsDatasetsHl7V2StoresMessages()

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

public listProjectsLocationsDatasetsHl7V2StoresMessages(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_ListMessagesResponse

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
$parent : string

Name of the HL7v2 store to retrieve messages from.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Limit on the number of messages to return in a single response. If zero the default page size of 100 is used.

opt_param

string filter Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * message_type, from the MSH-9.1 field. For example, NOT message_type = "ADT". * send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, send_date < "2017-01-02". * send_time, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, send_time < "2017-01-02T00:00:00-05:00". * send_facility, the care center that the message came from, from the MSH-4 segment. For example, send_facility = "ABC". * PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, PatientId("123456", "MRN"). * labels.x, a string value of the label with key x as set using the Message.labels map. For example, labels."priority"="high". The operator :* can be used to assert the existence of a label. For example, labels."priority":*.

opt_param

string view Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a page_size larger than the default can generate a large response, which impacts the performance of this method.

opt_param

string orderBy Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * send_time

opt_param

string pageToken The next_page_token value returned from the previous List request, if any.

Return values
Google_Service_CloudHealthcare_ListMessagesResponse —

patch()

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.

public patch(string $name, Google_Service_CloudHealthcare_Message $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Message

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
$name : string

Resource name of the Message, of the form projects/{proj ect_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message _id}. Assigned by the server.

$postBody : Google_Service_CloudHealthcare_Message
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#fieldmask

Return values
Google_Service_CloudHealthcare_Message —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results