Interface: XAD

HL7 v2 Extended Address (XAD): structured postal address per HL7 Chapter 2. All 12 components are optional. Fields are OMITTED when the underlying component is absent (exactOptionalPropertyTypes).

Component positions (HL7 1-indexed; this interface is 0-indexed by key):

1. street: street address (house number + street name).
2. otherDesignation: apartment number, suite, floor, etc.
3. city
4. stateOrProvince
5. zipOrPostalCode
6. country (ISO-3166 3-letter, e.g. "USA", "CAN")
7. addressType (H=Home, B=Business, M=Mailing, O=Office, P=Permanent, ...)
8. otherGeographicDesignation
9. countyParishCode
10. censusTract
11. addressRepresentationCode
12. addressValidityRange

Example

import type { XAD } from "@cosyte/hl7";
const addr: XAD = { street: "123 Main St", city: "Boston", stateOrProvince: "MA" };

Properties

addressRepresentationCode?

readonly optional addressRepresentationCode?: string

---

addressType?

readonly optional addressType?: string

---

addressValidityRange?

readonly optional addressValidityRange?: string

---

censusTract?

readonly optional censusTract?: string

---

city?

readonly optional city?: string

---

country?

readonly optional country?: string

---

countyParishCode?

readonly optional countyParishCode?: string

---

otherDesignation?

readonly optional otherDesignation?: string

---

otherGeographicDesignation?

readonly optional otherGeographicDesignation?: string

---

stateOrProvince?

readonly optional stateOrProvince?: string

---

street?

readonly optional street?: string

---

zipOrPostalCode?

readonly optional zipOrPostalCode?: string