HL7v2.Type.EIP (HL7v2 v3.10.1)

Entity Identifier Pair (EIP) -- HL7v2 composite data type.

Used to convey a pair of placer and filler identifiers (e.g., parent order references in ORC-8 and OBR-29).

2 components:

Placer Assigned Identifier (EI) -- sub-components delimited by &
Filler Assigned Identifier (EI) -- sub-components delimited by &

Summary

Types

t()

Functions

encode(eip)

Encodes an EIP to a list of component strings.

parse(components)

Parses an EIP from a list of components.

Types

t()

@type t() :: %HL7v2.Type.EIP{
  filler_assigned_identifier: HL7v2.Type.EI.t() | nil,
  placer_assigned_identifier: HL7v2.Type.EI.t() | nil
}

Functions

encode(eip)

@spec encode(t() | nil) :: list()

Encodes an EIP to a list of component strings.

Examples

iex> HL7v2.Type.EIP.encode(%HL7v2.Type.EIP{placer_assigned_identifier: %HL7v2.Type.EI{entity_identifier: "P123", namespace_id: "HOSP"}})
["P123&HOSP"]

iex> HL7v2.Type.EIP.encode(nil)
[]

parse(components)

@spec parse(list()) :: t()

Parses an EIP from a list of components.

Examples

iex> HL7v2.Type.EIP.parse(["P123&HOSP&2.16.840&ISO", "F456&LAB&2.16.841&ISO"])
%HL7v2.Type.EIP{
  placer_assigned_identifier: %HL7v2.Type.EI{entity_identifier: "P123", namespace_id: "HOSP", universal_id: "2.16.840", universal_id_type: "ISO"},
  filler_assigned_identifier: %HL7v2.Type.EI{entity_identifier: "F456", namespace_id: "LAB", universal_id: "2.16.841", universal_id_type: "ISO"}
}

iex> HL7v2.Type.EIP.parse(["P123"])
%HL7v2.Type.EIP{placer_assigned_identifier: %HL7v2.Type.EI{entity_identifier: "P123"}}

iex> HL7v2.Type.EIP.parse([])
%HL7v2.Type.EIP{}