HL7v2.Validation.FieldRules (HL7v2 v3.10.1)

Copy Markdown View Source

Field-level validation rules for HL7v2 typed segments.

For each typed segment struct, checks:

  • Required fields (:r optionality) are not nil
  • Repeating fields with bounded max_reps do not exceed the limit
  • Coded fields against HL7-defined tables (opt-in via validate_tables: true)

Summary

Functions

check(segment, opts \\ [])

Returns a list of field-level validation errors/warnings for a single segment.

conditional_errors(segment, location, mode, context \\ %{})

Returns a list of conditional-rule errors/warnings for a segment.

Functions

check(segment, opts \\ [])

@spec check(
  struct() | {binary(), list()},
  keyword()
) :: [map()]

Returns a list of field-level validation errors/warnings for a single segment.

Skips validation for:

  • HL7v2.Segment.ZXX (site-defined, no typed fields)
  • Raw tuples {name, fields} (not typed)

Options

  • :validate_tables -- when true, checks coded fields against HL7 tables. Defaults to false.

conditional_errors(segment, location, mode, context \\ %{})

@spec conditional_errors(struct(), String.t(), atom(), map()) :: [map()]

Returns a list of conditional-rule errors/warnings for a segment.

Conditional rules are HL7-specified dependencies between fields. In strict mode they produce :error, in lenient mode :warning.

An optional context map may contain :trigger_event and :message_code extracted from MSH-9. When provided, trigger-aware rules (e.g., scheduling modification segments, PV2 transfer events) use definitive checks instead of heuristic approximations.

Examples

# Without context (backwards compatible)
conditional_errors(segment, "AIS", :lenient)

# With trigger context
conditional_errors(segment, "AIS", :strict, %{trigger_event: "S03", message_code: "SIU"})