REST Resource: projects.locations.datasets.hl7V2Stores.messages

Resource: Message

A complete HL7v2 message. See http://www.hl7.org/implement/standards/index.cfm?ref=common for details on the standard.

JSON representation
{
  "name": string,
  "data": string,
  "createTime": string,
  "sendFacility": string,
  "sendTime": string,
  "messageType": string,
  "patientIds": [
    {
      object(PatientId)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "parsedData": {
    object(ParsedData)
  }
}
Fields
name

string

Resource name of the Message, of the form projects/{projectId}/datasets/{datasetId}/hl7V2Stores/{hl7V2StoreId}/messages/{message_id}. Assigned by the server.

data

string (bytes format)

Raw message bytes.

A base64-encoded string.

createTime

string(Timestamp format)

Output only. The datetime when the message was created. Set by the server.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

sendFacility

string

The hospital that this message came from. MSH-4.

sendTime

string(Timestamp format)

The datetime the sending application sent this message. MSH-7.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

messageType

string

The message type and trigger event for this message. MSH-9.

patientIds[]

object(PatientId)

All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.

labels

map (key: string, value: string)

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}][\p{Ll}\p{Lo}\p{N}_-]{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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parsedData

object(ParsedData)

Output only. The parsed version of the raw message data.

PatientId

A patient identifier and associated type.

JSON representation
{
  "value": string,
  "type": string
}
Fields
value

string

The patient's unique identifier.

type

string

ID type, e.g. MRN or NHS.

ParsedData

The content of a HL7v2 message in a structured format.

JSON representation
{
  "segments": [
    {
      object(Segment)
    }
  ]
}
Fields
segments[]

object(Segment)

Segment

A segment in a structured format.

JSON representation
{
  "segmentId": string,
  "setId": string,
  "fields": {
    string: string,
    ...
  }
}
Fields
segmentId

string

A string that indicates the type of segment, e.g., EVN, PID.

setId

string

Set ID for segments that can be in a set. This can be empty if it is missing or it is not applicable.

fields

map (key: string, value: string)

A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)([\d+])?(.\d+)?(.\d+)?

Examples of (key, value) pairs: - (0.1, "foo"): Component 1 of Field 0 has the value "foo". - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value "bar". - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, has the value "baz".

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

create

Creates a message and sends a notification to the Cloud Pub/Sub topic.

delete

Deletes an HL7v2 message.

get

Gets an HL7v2 message.

ingest

Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic.

list

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

patch

Update the message.
Var denne siden nyttig? Si fra hva du synes:

Send tilbakemelding om ...

Cloud Healthcare API