Struct Message 

pub struct Message {
    pub hl7_message: String,
    pub version: String,
    pub message_structure: String,
    pub message_control_id: String,
    pub processing_id: String,
    pub segment_count: usize,
    pub encoding: HL7Encoding,
    /* private fields */
}

A parsed HL7 v2 message: a collection of Segments keyed by name, plus the message-level metadata extracted from the MSH segment.

Fields

hl7_message: String

The raw message text (normalized after parsing).

version: String

HL7 version from MSH-12.

message_structure: String

Message structure from MSH-9.3 (or a derived value).

message_control_id: String

Message control ID from MSH-10.

processing_id: String

Processing ID from MSH-11.

segment_count: usize

Number of segments in the message.

encoding: HL7Encoding

The encoding (delimiters) used by the message.

Implementations

impl Message

pub fn new() -> Self

Creates an empty message with default encoding.

pub fn with_message(text: impl Into<String>) -> Self

Creates a message wrapping the given raw HL7 text (not yet parsed).

pub fn parse_str( text: impl Into<String>, bypass_validation: bool, ) -> Result<Self, Hl7Error>

Convenience: wraps and parses text in one step.

pub fn parse(&mut self, bypass_validation: bool) -> Result<bool, Hl7Error>

Parses Self::hl7_message into segments/fields/components.

Returns true when the message round-trips (re-serializing yields the same text). Pass bypass_validation = true to skip structural validation (do not use for newly constructed messages).

pub fn serialize(&self) -> Result<String, Hl7Error>

Serializes the message back to HL7 text.

pub fn get_value(&self, path: &str) -> Result<String, Hl7Error>

Gets the value at a path such as PID.5.2 (segment.field.component.subcomponent).

A segment occurrence may be supplied as PID(2).5. Returns the decoded value; a “present but null” value is returned as an empty string.

pub fn set_value(&mut self, path: &str, value: &str) -> Result<bool, Hl7Error>

Sets the value at a path such as PID.5.2 in every matching segment.

pub fn is_componentized(&self, path: &str) -> Result<bool, Hl7Error>

Whether the field at path is componentized.

pub fn has_repetitions(&self, path: &str) -> Result<bool, Hl7Error>

Whether the field at path has repetitions.

pub fn is_subcomponentized(&self, path: &str) -> Result<bool, Hl7Error>

Whether the component at path is subcomponentized.

pub fn add_new_segment(&mut self, segment: Segment) -> bool

Appends a segment, assigning it the next sequence number.

pub fn remove_segment(&mut self, segment_name: &str, index: usize) -> bool

Removes the index-th segment with the given name.

pub fn segments(&self) -> Vec<&Segment>

All segments in original order.

pub fn segments_named(&self, segment_name: &str) -> Vec<&Segment>

All segments with the given name, in original order.

pub fn default_segment(&self, segment_name: &str) -> Option<&Segment>

The first segment with the given name.

pub fn segments_named_mut( &mut self, segment_name: &str, ) -> Option<&mut Vec<Segment>>

Mutable access to all segments with the given name, in original order.

pub fn add_segment_msh( &mut self, sending_application: &str, sending_facility: &str, receiving_application: &str, receiving_facility: &str, security: Option<&str>, message_type: &str, message_control_id: &str, processing_id: &str, version: &str, ) -> Result<(), Hl7Error>

Builds and appends an MSH header segment.

pub fn get_ack(&self, bypass_validation: bool) -> Option<Message>

Builds the positive acknowledgement (ACK, code AA) for this message.

pub fn get_nack( &self, code: &str, err_msg: &str, bypass_validation: bool, ) -> Option<Message>

Builds a negative acknowledgement (NACK) with the given code and message.

pub fn get_mllp(&self) -> Result<Vec<u8>, Hl7Error>

Serializes the message into an MLLP-framed byte buffer.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Message

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Returns the “default value” for a type.