FHIR Address Data Type (R5)

Address describes a postal or physical address. Element table, example JSON and FHIRPath for FHIR R5.

FHIR Address Data Type (R5) — part of the free FHIR Toolbox library.
Runs entirely in your browser: your FHIR data is never uploaded to a server.

Overview

Address describes a postal or physical address. line is an ordered array of street lines; city, state, postalCode and country hold the rest.

Elements

Element	Type	Cardinality	Description
Address.use	code	0..1	home \| work \| temp \| old \| billing - purpose of this address
Address.type	code	0..1	postal \| physical \| both
Address.line	string	0..*	Street name, number, direction & P.O. Box etc.
Address.city	string	0..1	Name of city, town etc.
Address.district	string	0..1	District name (aka county)
Address.state	string	0..1	Sub-unit of country (abbreviations ok)
Address.postalCode	string	0..1	Postal code for area
Address.country	string	0..1	Country (e.g. may be ISO 3166 2 or 3 letter code)
Address.period	Period	0..1	Time period when address was/is in use

Example JSON (R5)

{
  "use": "home",
  "type": "both",
  "line": [
    "123 Main St",
    "Apt 4"
  ],
  "city": "Anytown",
  "state": "CA",
  "postalCode": "90210",
  "country": "US"
}

FHIRPath

Patient.address.where(use='home').city — City of the home address
Patient.address.postalCode — All postal codes

FHIR Toolbox is a free, privacy-first collection of HL7 FHIR utilities by Omindra Labs. Every tool performs zero-server processing — your health data never leaves your device.