IHE Patient Administration Management (PAM) conformance profiles.
Ships factory functions for the two PAM transactions in the IHE ITI Technical Framework Vol 2:
- ITI-30 Patient Identity Management — manages patient demographics outside a visit context (A28 create, A31 update, A40 merge, A47 change ID list). Source: IHE ITI TF-2b §3.30.
- ITI-31 Patient Encounter Management — manages the life cycle of a patient encounter (A01 admit, A02 transfer, A03 discharge, A04 register outpatient, A05 pre-admit, A06/A07 class change, A08 update, A11 cancel admit, A40 merge, and more). Source: IHE ITI TF-2b §3.31.
Both transactions are defined on HL7 v2.5. Each factory returns a
%HL7v2.Profile{} preconfigured with the IHE constraints from the
TF — required segments, required fields, forbidden fields,
cross-segment rules (e.g. PID-3 Assigning Authority).
Usage
profile = HL7v2.Profiles.IHE.PAM.iti_31_adt_a01()
{:ok, msg} = HL7v2.parse(wire, mode: :typed)
case HL7v2.Validation.ProfileRules.check(msg, profile) do
[] -> :conformant
errors -> {:non_conformant, errors}
endOr pass as a validation option:
HL7v2.validate(msg, profile: HL7v2.Profiles.IHE.PAM.iti_31_adt_a01())Summary
Functions
Returns the complete PAM profile catalog as a map keyed by IHE transaction code.
ITI-30 ADT^A28 — Add Person Information (no visit context).
ITI-30 ADT^A31 — Update Person Information (no visit context).
ITI-30 ADT^A40 — Merge Patient — Patient ID List.
ITI-31 ADT^A01 — Admit/Visit Notification.
ITI-31 ADT^A03 — Discharge/End Visit.
ITI-31 ADT^A04 — Register a Patient (outpatient).
ITI-31 ADT^A08 — Update Patient Information.
Functions
@spec all() :: %{required(String.t()) => HL7v2.Profile.t()}
Returns the complete PAM profile catalog as a map keyed by IHE transaction code.
@spec iti_30_adt_a28() :: HL7v2.Profile.t()
ITI-30 ADT^A28 — Add Person Information (no visit context).
Used when the sender has no visit context for the patient. PV1 is
still present as a "pseudo-segment" with PV1-2 pinned to "N"
(Not Applicable).
Source: IHE ITI TF-2b §3.30.
@spec iti_30_adt_a31() :: HL7v2.Profile.t()
ITI-30 ADT^A31 — Update Person Information (no visit context).
Same structure as A28 — PV1-2 pinned to "N".
Source: IHE ITI TF-2b §3.30.
@spec iti_30_adt_a40() :: HL7v2.Profile.t()
ITI-30 ADT^A40 — Merge Patient — Patient ID List.
Patient-level merge. Belongs to the IHE ITI-30 Patient Identity Management transaction, NOT to ITI-31 Patient Encounter Management. Requires MSH, EVN, PID, MRG. PV1 is forbidden because ITI-30 operates outside a visit context.
MRG-1 (Prior Patient Identifier List) is required; its Assigning Authority should match PID-3's.
Source: IHE ITI TF-2b §3.30 (Merge Option).
@spec iti_31_adt_a01() :: HL7v2.Profile.t()
ITI-31 ADT^A01 — Admit/Visit Notification.
Requires MSH, EVN, PID, PV1. PV1-2 (Patient Class) and PV1-3 (Assigned Patient Location) must be populated per IHE ITI TF-2b §3.31.4.1.2. PID-3 requires a populated Assigning Authority.
Source: IHE ITI TF-2b §3.31.
@spec iti_31_adt_a03() :: HL7v2.Profile.t()
ITI-31 ADT^A03 — Discharge/End Visit.
Requires MSH, EVN, PID, PV1. PV1-3 is not required for A03 (the discharge point is in PV1-45, not the bed). PV1-2 still required for the patient class context.
Source: IHE ITI TF-2b §3.31.
@spec iti_31_adt_a04() :: HL7v2.Profile.t()
ITI-31 ADT^A04 — Register a Patient (outpatient).
Same constraints as A01. PV1-3 still required for bed/location.
Source: IHE ITI TF-2b §3.31.
@spec iti_31_adt_a08() :: HL7v2.Profile.t()
ITI-31 ADT^A08 — Update Patient Information.
Same baseline as A01 including PV1-3 (the updated visit is still referenced). Source: IHE ITI TF-2b §3.31.