Message

A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.

HealthcareFHIRHL7v2DICOMMedical ImagingDe-identificationInteroperabilityCloud

Properties

Name Type Description
createTime string Output only. The datetime when the message was created. Set by the server.
data string Required. Raw message bytes.
labels object 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 reg
messageType string The message type for this message. MSH-9.1.
name string Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server
parsedData object Output only. The parsed version of the raw message data.
patientIds array All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
schematizedData object The parsed version of the raw message data schematized according to this store's schemas and type definitions.
sendFacility string The hospital that this message came from. MSH-4.
sendTime string The datetime the sending application sent this message. MSH-7.
View JSON Schema on GitHub

JSON Schema

Message.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Message",
  "description": "A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.",
  "properties": {
    "createTime": {
      "description": "Output only. The datetime when the message was created. Set by the server.",
      "format": "google-datetime",
      "readOnly": true,
      "type": "string"
    },
    "data": {
      "description": "Required. Raw message bytes.",
      "format": "byte",
      "type": "string"
    },
    "labels": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "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.",
      "type": "object"
    },
    "messageType": {
      "description": "The message type for this message. MSH-9.1.",
      "type": "string"
    },
    "name": {
      "description": "Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.",
      "readOnly": true,
      "type": "string"
    },
    "parsedData": {
      "$ref": "#/components/schemas/ParsedData",
      "description": "Output only. The parsed version of the raw message data.",
      "readOnly": true
    },
    "patientIds": {
      "description": "All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.",
      "items": {
        "$ref": "#/components/schemas/PatientId"
      },
      "type": "array"
    },
    "schematizedData": {
      "$ref": "#/components/schemas/SchematizedData",
      "description": "The parsed version of the raw message data schematized according to this store's schemas and type definitions."
    },
    "sendFacility": {
      "description": "The hospital that this message came from. MSH-4.",
      "type": "string"
    },
    "sendTime": {
      "description": "The datetime the sending application sent this message. MSH-7.",
      "format": "google-datetime",
      "type": "string"
    }
  },
  "type": "object"
}