| MyAddress (Address) | | | Address | There are no (further) constraints on this element Element idAddress Short descriptionAn address expressed using postal conventions (as opposed to GPS or other location definition formats) DefinitionAn 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 which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idAddress.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | | 0..* | Extension | Element idAddress.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
| planet | C | 1..1 | Extension(string) | Element idAddress.extension:planet Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
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.
Extension(string) Extension URLhttp://fhir.ufp/StructureDefinition/planet ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| quadrant | C | 1..1 | Extension(code) | Element idAddress.extension:quadrant Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
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.
Extension(code) Extension URLhttp://rambow.eu/ukw/fhir/StructureDefinition/quadrant ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idAddress.use Short descriptionhome | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address.
Allows an appropriate address to be chosen from a list of many.
Applications can assume that an address is current unless it explicitly says that it is temporary or old.
code BindingAddressUse (required) Examples
Generalhome Mappings- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAddress.type Short descriptionpostal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
code BindingThe type of an address (physical / postal).
AddressType (required) Examples
Generalboth Mappings- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAddress.text Short descriptionText representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
A renderable, unencoded form.
Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
string Examples
General137 Nowhere Street, Erewhon 9132 Mappings- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
| line | Σ | 0..* | string | There are no (further) constraints on this element Element idAddress.line Short descriptionStreet name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
string Examples
General137 Nowhere Street Mappings- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
|
| city | Σ | 0..1 | string | There are no (further) constraints on this element Element idAddress.city Short descriptionName of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center.
string Examples
GeneralErewhon Mappings- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
|
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idAddress.district Short descriptionDistrict name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county).
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.
string Examples
GeneralMadison Mappings- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
| state | Σ | 0..1 | string | There are no (further) constraints on this element Element idAddress.state Short descriptionSub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
string Mappings- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
| postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idAddress.postalCode Short descriptionPostal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service.
string Examples
General9132 Mappings- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
|
| country | Σ | 0..1 | string | There are no (further) constraints on this element Element idAddress.country Short descriptionCountry (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted.
ISO 3166 3 letter codes can be used in place of a human readable country name.
string Mappings- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idAddress.period Short descriptionTime period when address was/is in use DefinitionTime period when address was/is in use.
Allows addresses to be placed in historical context.
Period Examples
General{
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|