Class: Google::Apis::HealthcareV1::Message

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/healthcare_v1/classes.rb,
lib/google/apis/healthcare_v1/representations.rb,
lib/google/apis/healthcare_v1/representations.rb

Overview

A complete HL7v2 message. See Introduction to HL7 Standards for details on the standard.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



3737
3738
3739
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3737

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The datetime when the message was created. Set by the server. Corresponds to the JSON property createTime

Returns:

  • (String) 


3679
3680
3681
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3679

def create_time
  @create_time
end

#data ⇒ String

Required. Raw message bytes. Corresponds to the JSON property data NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3685
3686
3687
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3685

def data
  @data
end

#labels ⇒ Hash<String,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: \pLl\pLo 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: [\pLl\pLo\pN_-]0,63 No more than 64 labels can be associated with a given store. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3696
3697
3698
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3696

def labels
  @labels
end

#message_type ⇒ String

Output only. The message type for this message. MSH-9.1. Corresponds to the JSON property messageType

Returns:

  • (String) 


3701
3702
3703
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3701

def message_type
  @message_type
end

#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`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


3708
3709
3710
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3708

def name
  @name
end

#parsed_data ⇒ Google::Apis::HealthcareV1::ParsedData

The content of a HL7v2 message in a structured format. Corresponds to the JSON property parsedData

Returns:



3713
3714
3715
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3713

def parsed_data
  @parsed_data
end

#patient_ids ⇒ Array<Google::Apis::HealthcareV1::PatientId>

Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. Corresponds to the JSON property patientIds

Returns:



3719
3720
3721
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3719

def patient_ids
  @patient_ids
end

#schematized_data ⇒ Google::Apis::HealthcareV1::SchematizedData

The content of an HL7v2 message in a structured format as specified by a schema. Corresponds to the JSON property schematizedData

Returns:



3725
3726
3727
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3725

def schematized_data
  @schematized_data
end

#send_facility ⇒ String

Output only. The hospital that this message came from. MSH-4. Corresponds to the JSON property sendFacility

Returns:

  • (String) 


3730
3731
3732
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3730

def send_facility
  @send_facility
end

#send_time ⇒ String

Output only. The datetime the sending application sent this message. MSH-7. Corresponds to the JSON property sendTime

Returns:

  • (String) 


3735
3736
3737
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3735

def send_time
  @send_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3742

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data = args[:data] if args.key?(:data)
  @labels = args[:labels] if args.key?(:labels)
  @message_type = args[:message_type] if args.key?(:message_type)
  @name = args[:name] if args.key?(:name)
  @parsed_data = args[:parsed_data] if args.key?(:parsed_data)
  @patient_ids = args[:patient_ids] if args.key?(:patient_ids)
  @schematized_data = args[:schematized_data] if args.key?(:schematized_data)
  @send_facility = args[:send_facility] if args.key?(:send_facility)
  @send_time = args[:send_time] if args.key?(:send_time)
end