ex_hl7 v0.3.0 HL7.Composite.XAD

2.9.51 XAD - extended address

Components:

  • street_address (SAD)
  • other_designation (ST)
  • city (ST)
  • state (ST)
  • postal_code (ST)
  • country (ID)
  • address_type (ID)
  • other_geo_designation (ST)
  • county (IS)
  • census_tract (IS)
  • address_representation (ID)
  • address_validity (DR)

Subcomponents of street address (SAD):

  • mailing_address (ST)
  • street_name (ST)
  • dwelling_number (ST)

Subcomponents of address validity range (DR):

  • start_datetime (TS)
  • end_datetime (TS)

Example of usage for US:

|1234 Easy St.^Ste. 123^San Francisco^CA^95123^USA^B^^SF^|

This would be formatted for postal purposes as

1234 Easy St.
Ste. 123
San Francisco CA 95123

Example of usage for Australia:

|14th Floor^50 Paterson St^Coorparoo^QLD^4151|

This would be formatted for postal purposes using the same rules as for the American example as

14th Floor
50 Paterson St
Coorparoo QLD 4151

Summary

Functions

Create a new composite field

Types

t :: %HL7.Composite.XAD{address_type: binary, address_validity: HL7.Composite.DR.t, adrress_representation: binary, census_tract: binary, city: binary, country: binary, county: binary, other_designation: binary, other_geo_designation: binary, postal_code: binary, state: binary, street_address: binary}

Functions

new()

Specs

new :: t

Create a new composite field