Resource: Message
A complete HL7v2 message. See Introduction to HL7 Standards for details on the standard.
JSON representation |
---|
{ "name": string, "data": string, "createTime": string, "sendFacility": string, "sendTime": string, "messageType": string, "patientIds": [ { object( |
Fields | |
---|---|
name |
Output only. Resource name of the Message, of the form |
data |
Required. Raw message bytes. A base64-encoded string. |
createTime |
Output only. The datetime when the message was created. Set by the server. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
sendFacility |
Output only. The hospital that this message came from. MSH-4. |
sendTime |
Output only. The datetime the sending application sent this message. MSH-7. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
messageType |
Output only. The message type for this message. MSH-9.1. |
patientIds[] |
Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. |
labels |
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 |
parsedData |
Output only. The parsed version of the raw message data. |
schematizedData |
Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. |
PatientId
A patient identifier and associated type.
JSON representation |
---|
{ "value": string, "type": string } |
Fields | |
---|---|
value |
The patient's unique identifier. |
type |
ID type. For example, MRN or NHS. |
ParsedData
The content of a HL7v2 message in a structured format.
JSON representation |
---|
{
"segments": [
{
object( |
Fields | |
---|---|
segments[] |
|
Segment
A segment in a structured format.
JSON representation |
---|
{ "segmentId": string, "setId": string, "fields": { string: string, ... } } |
Fields | |
---|---|
segmentId |
A string that indicates the type of segment. For example, EVN or PID. |
setId |
Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable. |
fields |
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:
An object containing a list of |
SchematizedData
The content of an HL7v2 message in a structured format as specified by a schema.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
data |
JSON output of the parser. |
error |
The error output of the parser. |
Methods |
|
---|---|
|
Parses and stores an HL7v2 message. |
|
Deletes an HL7v2 message. |
|
Gets an HL7v2 message. |
|
Parses and stores an HL7v2 message. |
|
Lists all the messages in the given HL7v2 store with support for filtering. |
|
Update the message. |