Packages
hl7v2
3.3.3
3.10.1
3.9.0
3.8.0
3.7.0
3.6.0
3.5.0
3.4.0
3.3.6
3.3.5
3.3.4
3.3.3
3.3.2
3.3.1
3.3.0
3.2.0
3.1.1
3.1.0
3.0.2
3.0.1
3.0.0
2.11.0
2.10.0
2.9.1
2.9.0
2.8.2
2.8.1
2.8.0
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.0
2.1.3
2.1.2
2.1.1
2.1.0
1.4.6
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.0
1.2.0
1.1.0
1.0.0
0.6.0
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.1.0
Pure Elixir HL7 v2.x toolkit — schema-driven parsing, typed segments, message builder, MLLP transport
Current section
Files
Jump to
Current section
Files
lib/hl7v2/type/ndl.ex
defmodule HL7v2.Type.NDL do
@moduledoc """
Name with Date and Location (NDL) -- HL7v2 composite data type.
Used in OBR fields 32-35 to identify persons (interpreters, technicians,
transcriptionists) along with the time and location of their activity.
11 components per HL7 v2.5.1:
1. Name (CNN) -- sub-components delimited by `&`
2. Start Date/Time (TS) -- sub-components delimited by `&`
3. End Date/Time (TS) -- sub-components delimited by `&`
4. Point of Care (IS)
5. Room (IS)
6. Bed (IS)
7. Facility (HD) -- sub-components delimited by `&`
8. Location Status (IS)
9. Patient Location Type (IS)
10. Building (IS)
11. Floor (IS)
"""
@behaviour HL7v2.Type
alias HL7v2.Type
alias HL7v2.Type.{CNN, HD, TS}
defstruct [
:name,
:start_date_time,
:end_date_time,
:point_of_care,
:room,
:bed,
:facility,
:location_status,
:patient_location_type,
:building,
:floor
]
@type t :: %__MODULE__{
name: CNN.t() | nil,
start_date_time: TS.t() | nil,
end_date_time: TS.t() | nil,
point_of_care: binary() | nil,
room: binary() | nil,
bed: binary() | nil,
facility: HD.t() | nil,
location_status: binary() | nil,
patient_location_type: binary() | nil,
building: binary() | nil,
floor: binary() | nil
}
@doc """
Parses an NDL from a list of components.
Component 1 (Name/CNN), 2-3 (TS), and 7 (HD) contain sub-components
delimited by `&`.
## Examples
iex> HL7v2.Type.NDL.parse(["12345&Smith&John"])
%HL7v2.Type.NDL{
name: %HL7v2.Type.CNN{id_number: "12345", family_name: "Smith", given_name: "John"}
}
iex> HL7v2.Type.NDL.parse([])
%HL7v2.Type.NDL{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
name: Type.parse_sub(CNN, Type.get_component(components, 0)),
start_date_time: Type.parse_sub_ts(Type.get_component(components, 1)),
end_date_time: Type.parse_sub_ts(Type.get_component(components, 2)),
point_of_care: Type.get_component(components, 3),
room: Type.get_component(components, 4),
bed: Type.get_component(components, 5),
facility: Type.parse_sub(HD, Type.get_component(components, 6)),
location_status: Type.get_component(components, 7),
patient_location_type: Type.get_component(components, 8),
building: Type.get_component(components, 9),
floor: Type.get_component(components, 10)
}
end
@doc """
Encodes an NDL to a list of component strings.
## Examples
iex> HL7v2.Type.NDL.encode(%HL7v2.Type.NDL{name: %HL7v2.Type.CNN{id_number: "12345", family_name: "Smith", given_name: "John"}})
["12345&Smith&John"]
iex> HL7v2.Type.NDL.encode(nil)
[]
iex> HL7v2.Type.NDL.encode(%HL7v2.Type.NDL{})
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = ndl) do
[
Type.encode_sub(CNN, ndl.name),
Type.encode_sub_ts(ndl.start_date_time),
Type.encode_sub_ts(ndl.end_date_time),
ndl.point_of_care || "",
ndl.room || "",
ndl.bed || "",
Type.encode_sub(HD, ndl.facility),
ndl.location_status || "",
ndl.patient_location_type || "",
ndl.building || "",
ndl.floor || ""
]
|> Type.trim_trailing()
end
end