3.23.6 StructureDefinition: Shared Health Address - Detailed Descriptions
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. |
Control | 0..* |
Comments | Note: address is for postal addresses, not physical locations. |
Max Length | 0 |
2. Address.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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 Length | 0 |
4. Address.use | |
Definition | The purpose of this address. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUse The use of an address |
Type | code |
Is Modifier | true |
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 Length | 0 |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressType (20210501) |
Type | code |
Must Support | true |
Max Length | 0 |
Example | General:both PrescribeIT:both |
6. Address.text | |
Definition | A full text representation of the address. |
Control | 0..1 |
Type | string |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. |
Max Length | 0 |
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. |
Control | 0..2 |
Type | string |
Must Support | true |
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 Length | 0 |
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. |
Control | 0..1 |
Type | string |
Must Support | true |
Alternate Names | Municpality |
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 Length | 0 |
Example | General:Erewhon PrescribeIT:Toronto |
9. Address.district | |
Definition | The name of the administrative area (county). |
Control | 0..1 |
Type | string |
Alternate Names | County |
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 Length | 0 |
Example | General:Madison |
10. Address.state | |
Definition | A two-letter code for a Canadian jurisdiction (province or territory). |
Control | 0..1 |
Binding | The codes SHALL be taken from CanadianJurisdiction (20170626) |
Type | string |
Must Support | true |
Alternate Names | Province, 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 Length | 0 |
Example | PrescribeIT:ON |
11. Address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..1 |
Type | string |
Must Support | true |
Alternate Names | Zip |
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 Length | 0 |
Example | General:9132 PrescribeIT:H3H 3H3 |
12. Address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Control | 0..1 |
Type | string |
Must Support | true |
Comments | Conformance Rule: As this is a string data type, reminder to structure for readability and presentation. |
Max Length | 0 |
Example | PrescribeIT:Canada |
13. Address.period | |
Definition | Time period when address was/is in use. |
Control | 0..1 |
Type | Period |
Requirements | Allows addresses to be placed in historical context. |
Max Length | 0 |
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> |