HL7v2.Profiles.IHE.PIX (HL7v2 v3.10.1)

Copy Markdown View Source

IHE Patient Identifier Cross-Reference (PIX) conformance profiles.

Ships factory functions for the three PIX transactions in the IHE ITI Technical Framework Vol 2:

  • ITI-8 Patient Identity Feed — ADT^A01/A04/A08/A40 sent from a Patient Identity Source to a PIX Manager or XDS Document Registry. Defined on HL7 v2.3.1 (PIX is one of the earliest IHE profiles and its version has not been rebased). Source: IHE ITI TF-2 §3.8.
  • ITI-9 PIX Query — QBP^Q23 request / RSP^K23 response. Defined on HL7 v2.5. Source: IHE ITI TF-2 §3.9.
  • ITI-10 PIX Update Notification — ADT^A31 with PV1-2 pinned to "N". Defined on HL7 v2.5. Source: IHE ITI TF-2 §3.10.

Note the version mix: ITI-8 is the only PIX transaction on v2.3.1. The profile DSL gates each profile by both message type AND version, so an ITI-8 v2.3.1 feed profile will not accidentally match a v2.5 ADT^A01.

Usage

profile = HL7v2.Profiles.IHE.PIX.iti_8_feed_a01()
HL7v2.validate(msg, profile: profile)

Summary

Functions

all()

Returns the complete PIX profile catalog.

iti_8_feed_a01()

ITI-8 ADT^A01 Patient Identity Feed — Admit Inpatient. HL7 v2.3.1. Source: IHE ITI TF-2 §3.8.

iti_8_feed_a04()

ITI-8 ADT^A04 Patient Identity Feed — Register Outpatient. HL7 v2.3.1. Source: IHE ITI TF-2 §3.8.

iti_8_feed_a08()

ITI-8 ADT^A08 Patient Identity Feed — Update Patient Information. HL7 v2.3.1. Source: IHE ITI TF-2 §3.8.

iti_8_feed_a40()

ITI-8 ADT^A40 Patient Identity Feed — Merge Patient. HL7 v2.3.1. Requires MRG segment and MRG-1 populated. Source: IHE ITI TF-2 §3.8.

iti_9_query()

ITI-9 QBP^Q23 — PIX Query. HL7 v2.5.

iti_9_response()

ITI-9 RSP^K23 — PIX Query Response. HL7 v2.5.

iti_10_update()

ITI-10 ADT^A31 — PIX Update Notification. HL7 v2.5.

Functions

all()

@spec all() :: %{required(String.t()) => HL7v2.Profile.t()}

Returns the complete PIX profile catalog.

iti_8_feed_a01()

@spec iti_8_feed_a01() :: HL7v2.Profile.t()

ITI-8 ADT^A01 Patient Identity Feed — Admit Inpatient. HL7 v2.3.1. Source: IHE ITI TF-2 §3.8.

iti_8_feed_a04()

@spec iti_8_feed_a04() :: HL7v2.Profile.t()

ITI-8 ADT^A04 Patient Identity Feed — Register Outpatient. HL7 v2.3.1. Source: IHE ITI TF-2 §3.8.

iti_8_feed_a08()

@spec iti_8_feed_a08() :: HL7v2.Profile.t()

ITI-8 ADT^A08 Patient Identity Feed — Update Patient Information. HL7 v2.3.1. Source: IHE ITI TF-2 §3.8.

iti_8_feed_a40()

@spec iti_8_feed_a40() :: HL7v2.Profile.t()

ITI-8 ADT^A40 Patient Identity Feed — Merge Patient. HL7 v2.3.1. Requires MRG segment and MRG-1 populated. Source: IHE ITI TF-2 §3.8.

iti_9_query()

@spec iti_9_query() :: HL7v2.Profile.t()

ITI-9 QBP^Q23 — PIX Query. HL7 v2.5.

Requires MSH, QPD, RCP. QPD-1 is pinned to "IHE PIX Query" and RCP-1 is pinned to "I" (Immediate mode). QPD-3 (Person Identifier) must be populated.

Source: IHE ITI TF-2 §3.9.

iti_9_response()

@spec iti_9_response() :: HL7v2.Profile.t()

ITI-9 RSP^K23 — PIX Query Response. HL7 v2.5.

Requires MSH, MSA, QAK, QPD. PID is optional — present only when patient IDs were found. QAK-2 carries the response status (OK, NF, AE per IHE ITI TF-2 §3.9.4.2).

Source: IHE ITI TF-2 §3.9.

iti_10_update()

@spec iti_10_update() :: HL7v2.Profile.t()

ITI-10 ADT^A31 — PIX Update Notification. HL7 v2.5.

Sent by the PIX Manager when a patient's cross-reference set changes. PV1-2 is pinned to "N" (Not Applicable) because the notification is sent outside a visit context. The PIX Manager returns a single space for PID-5 to avoid domain-specific name conflicts (this is a recommendation, not a hard rule here).

Source: IHE ITI TF-2 §3.10.