Interface: PL
HL7 v2 Person Location (PL): structured location per HL7 Chapter 2. All
11 v1 components are optional. Fields are OMITTED when the underlying
component is absent (exactOptionalPropertyTypes). facility uses the
nested HD shape; assigningAuthorityForLocation is flattened to a
plain string in v1 (HL7 spec treats it as HD-shaped).
Component positions (HL7 1-indexed; this interface is 0-indexed by key):
- pointOfCare: e.g. "ICU", "ED"
- room
- bed
- facility: nested HD (3 subcomponents form an HD composite)
- locationStatus: O=Occupied, U=Unoccupied, K=Contaminated, C=Closed, H=Housekeeping, I=Isolated
- personLocationType: C=Clinic, D=Department, H=Home, N=Nursing Unit, O=Office, R=Revenue Location
- building
- floor
- locationDescription: free-text
- comprehensiveLocationId
- assigningAuthorityForLocation (v1: flattened to string)
Example
import type { PL } from "@cosyte/hl7";
const bed: PL = {
pointOfCare: "ICU",
room: "101",
bed: "A",
facility: { namespaceId: "HOSP", universalId: "1.2.3", universalIdType: "UUID" },
};
Properties
assigningAuthorityForLocation?
readonlyoptionalassigningAuthorityForLocation?:string
bed?
readonlyoptionalbed?:string
building?
readonlyoptionalbuilding?:string
comprehensiveLocationId?
readonlyoptionalcomprehensiveLocationId?:string
facility?
readonlyoptionalfacility?:HD
floor?
readonlyoptionalfloor?:string
locationDescription?
readonlyoptionallocationDescription?:string
locationStatus?
readonlyoptionallocationStatus?:string
personLocationType?
readonlyoptionalpersonLocationType?:string
pointOfCare?
readonlyoptionalpointOfCare?:string
room?
readonlyoptionalroom?:string