Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource

The "messages" collection of methods.

Inheritance
System.Object
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class MessagesResource

Constructors

MessagesResource(IClientService)

Constructs a new resource.

Declaration
public MessagesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(CreateMessageRequest, String)

Creates a message and sends a notification to the Cloud Pub/Sub topic. If configured, the MLLP adapter listens to messages created by this method and sends those back to the hospital. A successful response indicates the message has been persisted to storage and a Cloud Pub/Sub notification has been sent. Sending to the hospital by the MLLP adapter happens asynchronously.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.CreateRequest Create(CreateMessageRequest body, string parent)
Parameters
Type Name Description
CreateMessageRequest body

The body of the request.

System.String parent

The name of the dataset this message belongs to.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.CreateRequest

Delete(String)

Deletes an HL7v2 message.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
System.String name

The resource name of the HL7v2 message to delete.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.DeleteRequest

Get(String)

Gets an HL7v2 message.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.GetRequest Get(string name)
Parameters
Type Name Description
System.String name

The resource name of the HL7v2 message to retrieve.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.GetRequest

Ingest(IngestMessageRequest, String)

Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.IngestRequest Ingest(IngestMessageRequest body, string parent)
Parameters
Type Name Description
IngestMessageRequest body

The body of the request.

System.String parent

The name of the HL7v2 store this message belongs to.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.IngestRequest

List(String)

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.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest List(string parent)
Parameters
Type Name Description
System.String parent

Name of the HL7v2 store to retrieve messages from.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest

Patch(Message, String)

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.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.PatchRequest Patch(Message body, string name)
Parameters
Type Name Description
Message body

The body of the request.

System.String name

Resource name of the Message, of the form projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}. Assigned by the server.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.PatchRequest
Back to top