Shared Health Specification and Guide Version 5.0


v5.0 of this specification has been superseded by v5.3. v5.3 is compatible but adds additional features for Quebec.

The version (Bundle.meta.tag:version) that is sent in the message will remain PrescribeIT5.0

 

Definitions for the dtprofile-address Profile.

1. Address
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.

Control0..*
Comments

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

Max Length0
2. Address.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
3. Address.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
4. Address.use
Definition

The purpose of this address.

Control0..1
BindingThe codes SHALL be taken from AddressUse The use of an address
Typecode
Is Modifiertrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Max Length0
Example
General:home
PrescribeIT:home
5. Address.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Control0..1
BindingThe codes SHALL be taken from AddressType (20210501)
Typecode
Must Supporttrue
Max Length0
Example
General:both
PrescribeIT:both
6. Address.text
Definition

A full text representation of the address.

Control0..1
Typestring
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts.

Max Length0
Example
General:137 Nowhere Street, Erewhon 9132
7. Address.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Control0..2
Typestring
Must Supporttrue
Requirements

home | work | temp | old - purpose of this address.

Comments

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

Max Length0
Example
General:137 Nowhere Street
PrescribeIT:10-123 Main Street NW
8. Address.city
Definition

The name of the city, town, village or other community or delivery center.

Control0..1
Typestring
Must Supporttrue
Alternate NamesMunicpality
Comments

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

Usage note: For cities located outside Canada, this can be a combination of a city name and a province/state, for example ‘Tampa, FL’ or ‘Tampa, Florida’.

Max Length0
Example
General:Erewhon
PrescribeIT:Toronto
9. Address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Alternate NamesCounty
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Max Length0
Example
General:Madison
10. Address.state
Definition

A two-letter code for a Canadian jurisdiction (province or territory).

Control0..1
BindingThe codes SHALL be taken from CanadianJurisdiction (20170626)
Typestring
Must Supporttrue
Alternate NamesProvince, Territory
Comments

Conformance Rule: Invalid values, empty strings, or non-Canadian jurisdictions (for example, US states) are not allowed in this field.

Usage Note: If a 'city' field contains a combination of a city name and a province/state, then 'state' field should be omitted.

Max Length0
Example
PrescribeIT:ON
11. Address.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..1
Typestring
Must Supporttrue
Alternate NamesZip
Comments

For Organization Address - Conformance Rule: Format postal code as A#A #A# (case-insensitive, whitespaces will be ignored). For Patient Address - A properly formatted postal code should be provided where it can be (A#A #A#, case-insensitive, whitespaces will be ignored).

Conformance Rule: For addresses in Canada, only properly formatted Canadian postal codes should be provided in this field. For addresses outside Canada, the postal code format should preferably follow the conventions of the corresponding postal authority.

Max Length0
Example
General:9132
PrescribeIT:H3H 3H3
12. Address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Must Supporttrue
Comments

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

Max Length0
Example
PrescribeIT:Canada
13. Address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
Requirements

Allows addresses to be placed in historical context.

Max Length0
Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-22T09:00:00-04:00"/>
  <end value="2010-06-30T10:00:00-04:00"/>
</valuePeriod>