Shared Health Specification and Guide Version 2.0 Revision F

 

3.22 StructureDefinition: Shared Health Address

The official URL for this profile is: 

http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-address

3.22.2 Formal Views of Profile Content

Download Excel representation

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

>

This structure is derived from Address

NameCard.TypeConstraints and Usage
.  Address 0..*Definition:
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.


Comments:
Note: address is for postal addresses, not physical locations.

..  type 0..1codeBinding: AddressType (required)
Example' General': both
Example' ???': both
Definition:
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

..  line 0..2stringExample' General': 137 Nowhere Street
Example' ???': 137 Nowhere Street
Definition:
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.


Comments:
Conformance Rule: As this is a string data type, reminder to structure for readability and presentation.

..  city 0..1stringExample' General': Erewhon
Example' ???': Erewhon
Definition:
The name of the city, town, village or other community or delivery center.


Comments:
Conformance Rule: As this is a string data type, reminder to structure for readability and presentation.

..  state 0..1string​Binding: CanadianJurisdiction (required)
Definition:
Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).


Comments:
For ORGANIZATION Address - Conformance Rule: The following values will be supported to represent province;AB - Alberta, BC - British Columbia, MB - Manitoba, NB - New Brunswick, NL- Newfoundland and Labrador,NS - Nova Scotia, NT - Nowrthwest Territories, NU - Nunavet, ON - Ontario, PE - Prince Edward Island, QC - Quebec, SK - Saskatchewan, YT - Yukon Territories.

..  postalCode 0..1stringExample' General': 9132
Example' ???': 9132
Definition:
A postal code designating a region defined by the postal service.


Comments:
For Organization Address - Conformance Rule: Format postal code as A#A #A#. For Patient Address - A properly formatted postal code should be provided (A#A #A#) where it can be. If unknown, this can be populated with any acceptable format (until next release) where this will be moved to 0..1

..  country 0..1stringDefinition:
Country - a nation as commonly understood or generally accepted.


Comments:
Conformance Rule: Set value to Canada.

This structure is derived from Address

Summary

Must-Support: 6 elements

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*
... use 0..1codeExample ???': home
... type S0..1codeExample ???': both
... line S0..2stringExample ???': 137 Nowhere Street
... city S0..1stringExample ???': Erewhon
... state S0..1string​Binding: CanadianJurisdiction (required)
... postalCode S0..1stringExample ???': 9132
... country S0..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
Example ???': home
... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
Example ???': both
... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
... line SΣ0..2stringStreet name, number, direction & P.O. Box etc.

Example General': 137 Nowhere Street
Example ???': 137 Nowhere Street
... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
Example ???': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state SΣ0..1string​Sub-unit of country (abbreviations ok)
Binding: CanadianJurisdiction (required)
... postalCode SΣ0..1stringPostal code for area
Example General': 9132
Example ???': 9132
... country SΣ0..1stringCountry (can be ISO 3166 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-22T09:00:00-04:00","end":"2010-06-30T10:00:00-04:00"}

doco Documentation for this format

Grid View

This structure is derived from Address

NameCard.TypeConstraints and Usage
.  Address 0..*Definition:
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.


Comments:
Note: address is for postal addresses, not physical locations.

..  type 0..1codeBinding: AddressType (required)
Example' General': both
Example' ???': both
Definition:
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

..  line 0..2stringExample' General': 137 Nowhere Street
Example' ???': 137 Nowhere Street
Definition:
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.


Comments:
Conformance Rule: As this is a string data type, reminder to structure for readability and presentation.

..  city 0..1stringExample' General': Erewhon
Example' ???': Erewhon
Definition:
The name of the city, town, village or other community or delivery center.


Comments:
Conformance Rule: As this is a string data type, reminder to structure for readability and presentation.

..  state 0..1string​Binding: CanadianJurisdiction (required)
Definition:
Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).


Comments:
For ORGANIZATION Address - Conformance Rule: The following values will be supported to represent province;AB - Alberta, BC - British Columbia, MB - Manitoba, NB - New Brunswick, NL- Newfoundland and Labrador,NS - Nova Scotia, NT - Nowrthwest Territories, NU - Nunavet, ON - Ontario, PE - Prince Edward Island, QC - Quebec, SK - Saskatchewan, YT - Yukon Territories.

..  postalCode 0..1stringExample' General': 9132
Example' ???': 9132
Definition:
A postal code designating a region defined by the postal service.


Comments:
For Organization Address - Conformance Rule: Format postal code as A#A #A#. For Patient Address - A properly formatted postal code should be provided (A#A #A#) where it can be. If unknown, this can be populated with any acceptable format (until next release) where this will be moved to 0..1

..  country 0..1stringDefinition:
Country - a nation as commonly understood or generally accepted.


Comments:
Conformance Rule: Set value to Canada.

This structure is derived from Address

Summary

Must-Support: 6 elements

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*
... use 0..1codeExample ???': home
... type S0..1codeExample ???': both
... line S0..2stringExample ???': 137 Nowhere Street
... city S0..1stringExample ???': Erewhon
... state S0..1string​Binding: CanadianJurisdiction (required)
... postalCode S0..1stringExample ???': 9132
... country S0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
Example ???': home
... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
Example ???': both
... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
... line SΣ0..2stringStreet name, number, direction & P.O. Box etc.

Example General': 137 Nowhere Street
Example ???': 137 Nowhere Street
... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
Example ???': Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General': Madison
... state SΣ0..1string​Sub-unit of country (abbreviations ok)
Binding: CanadianJurisdiction (required)
... postalCode SΣ0..1stringPostal code for area
Example General': 9132
Example ???': 9132
... country SΣ0..1stringCountry (can be ISO 3166 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-22T09:00:00-04:00","end":"2010-06-30T10:00:00-04:00"}

doco Documentation for this format

 

Other representations of profile: Schematron

3.22.3 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Address.useAddressUserequiredAddressUse
Address.typeAddressTyperequiredAddressType
Address.stateCanadianJurisdictionrequired​CanadianJurisdiction

3.22.4 Constraints

Constraints

IdPathDetailsRequirements