3.23 StructureDefinition: Shared Health Address
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-address
3.23.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
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Address | 0..* | 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. Comments: Note: address is for postal addresses, not physical locations. |
 type | 0..1 | code | Binding: AddressType (20210501) (required) Example' General': both Example' PrescribeIT': 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..2 | string | Example' General': 137 Nowhere Street Example' PrescribeIT': 10-123 Main Street NW 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..1 | string | Example' General': Erewhon Example' PrescribeIT': Toronto 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. 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’. |
| state | 0..1 | string | Binding: CanadianJurisdiction (20170626) (required) Example' PrescribeIT': ON Definition: A two-letter code for a Canadian jurisdiction (province or 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. |
| postalCode | 0..1 | string | Example' General': 9132 Example' PrescribeIT': H3H 3H3 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# (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. |
 country | 0..1 | string | Example' PrescribeIT': Canada Definition: Country - a nation as commonly understood or generally accepted. Comments: Conformance Rule: As this is a string data type, reminder to structure for readability and presentation. |
This structure is derived from Address
This structure is derived from Address
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| use | 0..1 | code | home | work | temp | old - purpose of this address Example PrescribeIT: home | |
| type | S | 0..1 | code | postal | physical | both Binding: AddressType (20210501) (required) Example PrescribeIT: both |
| line | S | 0..2 | string | Street name, number, direction & P.O. Box etc. Example PrescribeIT: 10-123 Main Street NW |
| city | S | 0..1 | string | Name of city, town etc. Example PrescribeIT: Toronto |
| state | S | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: CanadianJurisdiction (20170626) (required) Example PrescribeIT: ON |
| postalCode | S | 0..1 | string | Postal code for area Example PrescribeIT: H3H 3H3 |
| country | S | 0..1 | string | Country (can be ISO 3166 3 letter code) Example PrescribeIT: Canada |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required): The use of an address Example General: home Example PrescribeIT: home |
| type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (20210501) (required) Example General: both Example PrescribeIT: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | SΣ | 0..2 | string | Street name, number, direction & P.O. Box etc. Example General: 137 Nowhere Street Example PrescribeIT: 10-123 Main Street NW |
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example PrescribeIT: Toronto |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: CanadianJurisdiction (20170626) (required) Example PrescribeIT: ON |
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 Example PrescribeIT: H3H 3H3 |
| country | SΣ | 0..1 | string | Country (can be ISO 3166 3 letter code) Example PrescribeIT: Canada |
 period | Σ | 0..1 | Period | Time 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"} |
| Documentation for this format | ||||
Grid View
This structure is derived from Address
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Address | 0..* | 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. Comments: Note: address is for postal addresses, not physical locations. |
| type | 0..1 | code | Binding: AddressType (20210501) (required) Example' General': both Example' PrescribeIT': 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..2 | string | Example' General': 137 Nowhere Street Example' PrescribeIT': 10-123 Main Street NW 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..1 | string | Example' General': Erewhon Example' PrescribeIT': Toronto 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. 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’. |
| state | 0..1 | string | Binding: CanadianJurisdiction (20170626) (required) Example' PrescribeIT': ON Definition: A two-letter code for a Canadian jurisdiction (province or 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. |
| postalCode | 0..1 | string | Example' General': 9132 Example' PrescribeIT': H3H 3H3 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# (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. |
| country | 0..1 | string | Example' PrescribeIT': Canada Definition: Country - a nation as commonly understood or generally accepted. Comments: Conformance Rule: As this is a string data type, reminder to structure for readability and presentation. |
This structure is derived from Address
Differential View
This structure is derived from Address
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| use | 0..1 | code | home | work | temp | old - purpose of this address Example PrescribeIT: home | |
| type | S | 0..1 | code | postal | physical | both Binding: AddressType (20210501) (required) Example PrescribeIT: both |
| line | S | 0..2 | string | Street name, number, direction & P.O. Box etc. Example PrescribeIT: 10-123 Main Street NW |
| city | S | 0..1 | string | Name of city, town etc. Example PrescribeIT: Toronto |
| state | S | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: CanadianJurisdiction (20170626) (required) Example PrescribeIT: ON |
| postalCode | S | 0..1 | string | Postal code for area Example PrescribeIT: H3H 3H3 |
| country | S | 0..1 | string | Country (can be ISO 3166 3 letter code) Example PrescribeIT: Canada |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | Address | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required): The use of an address Example General: home Example PrescribeIT: home |
| type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (20210501) (required) Example General: both Example PrescribeIT: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | SΣ | 0..2 | string | Street name, number, direction & P.O. Box etc. Example General: 137 Nowhere Street Example PrescribeIT: 10-123 Main Street NW |
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example PrescribeIT: Toronto |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: CanadianJurisdiction (20170626) (required) Example PrescribeIT: ON |
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 Example PrescribeIT: H3H 3H3 |
| country | SΣ | 0..1 | string | Country (can be ISO 3166 3 letter code) Example PrescribeIT: Canada |
| period | Σ | 0..1 | Period | Time 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"} |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.23.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Address.state | required | CanadianJurisdiction |
3.23.4 Constraints
Constraints
| Id | Path | Details | Requirements |