v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1376177324.7 KB
projects

Creates a new HL7v2 store within the parent dataset.

post/v1/{+parent}/hl7V2Stores

Path parameters

parentstring required

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

Query parameters

hl7V2StoreIdstring

Required. The ID of the HL7v2 store that is being created. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}.

Request body

namestring

Identifier. Resource name of the HL7v2 store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

labelsobject

User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.

rejectDuplicateMessageboolean

Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection.

Response

Successful response