Standard Health Record FHIR Implementation Guide

SHR Address Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Address

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR).

This profile builds on Address.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Summary

Mandatory: 0 element (1 nested mandatory element)

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.Address maps to Address:
  Purpose maps to use
  Type maps to type
  DisplayText maps to text
  AddressLine maps to line
  City maps to city
  District maps to district
  State maps to state
  PostalCode maps to postalCode
  Country maps to country
  EffectiveTimePeriod maps to period

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*SHR Address Profile
... id 0..1stringxml:id (or equivalent in JSON)
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
... line Σ0..2stringStreet name, number, direction & P.O. Box etc.
Example General': 137 Nowhere Street
... city Σ0..1stringName of city, town etc.
Example General': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General': 9132
... country Σ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.Address maps to Address:
  Purpose maps to use
  Type maps to type
  DisplayText maps to text
  AddressLine maps to line
  City maps to city
  District maps to district
  State maps to state
  PostalCode maps to postalCode
  Country maps to country
  EffectiveTimePeriod maps to period

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*SHR Address Profile
... id 0..1stringxml:id (or equivalent in JSON)
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
... line Σ0..2stringStreet name, number, direction & P.O. Box etc.
Example General': 137 Nowhere Street
... city Σ0..1stringName of city, town etc.
Example General': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General': 9132
... country Σ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Address.useAddressUserequiredAddressUse
Address.typeAddressTyperequiredAddressType

 

Constraints

IdPathDetailsRequirements
ele-1AddressAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())