Standard Health Record FHIR Implementation Guide

SHR UnitedStatesAddress Profile

 

The official URL for this profile is:

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

An address for a place in the USA, conforming to US mail postal conventions. (Source: HL7 FHIR).

This profile builds on Address.

This profile was published on Tue Feb 27 00:00:00 EST 2018 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 (2 nested mandatory elements)

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.UnitedStatesAddress 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
  UnitedStatesState maps to state
  PostalCode maps to postalCode
  Country maps to country
  EffectiveTimePeriod maps to period

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address SHR UnitedStatesAddress Profile
... line 0..2
... state 1..1
... country 1..1

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*SHR UnitedStatesAddress 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 Σ1..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 (2 nested mandatory elements)

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.UnitedStatesAddress 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
  UnitedStatesState maps to state
  PostalCode maps to postalCode
  Country maps to country
  EffectiveTimePeriod maps to period

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address SHR UnitedStatesAddress Profile
... line 0..2
... state 1..1
... country 1..1

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address I0..*SHR UnitedStatesAddress 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 Σ1..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())