PermanentAddress (Address) | | | BaseAddress | There are no (further) constraints on this element Element idShort description An address expressed using postal conventions (as opposed to GPS or other location definition formats) 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 which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
Comments 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).
Data type BaseAddress 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 idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type string Mappings |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May 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.
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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 | Σ ?! | 1..1 | codeBindingFixed Value | Element idShort description home | work | temp | old | billing - purpose of this address Definition The purpose of this address.
Requirements Allows an appropriate address to be chosen from a list of many.
Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Data type code Binding AddressUse (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Fixed value Mappings- rim: n/a
- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
type | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idShort description postal | physical | 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.
Comments 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).
Data type code Binding The type of an address (physical / postal).
AddressType (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim: n/a
- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
|
text | Σ | 0..0 | string | There are no (further) constraints on this element Element idShort description Text representation of the address Definition Specifies 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.
Requirements A renderable, unencoded form.
Comments 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.
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples General137 Nowhere Street, Erewhon 9132 Mappings- rim: n/a
- 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 idShort description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples General137 Nowhere Street Mappings- rim: n/a
- 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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idShort description City/Municipality Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim: n/a
- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
|
district | Σ | 1..1 | string | There are no (further) constraints on this element Element idShort description Province Alternate names County Definition The name of the administrative area (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.
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim: n/a
- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
state | Σ | 1..1 | string | There are no (further) constraints on this element Element idShort description Region Alternate names Province, Territory 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 (e.g. US 2 letter state codes).
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
postalCode | Σ | 1..1 | string | There are no (further) constraints on this element Element idShort description Postal code for area Alternate names Zip Definition A postal code designating a region defined by the postal service.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim: n/a
- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
|
country | Σ | 1..1 | stringFixed Value | There are no (further) constraints on this element Element idShort description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted.
Comments ISO 3166 3 letter codes can be used in place of a human readable country name.
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Fixed value Mappings- rim: n/a
- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
|
period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element idShort description Time period when address was/is in use Definition Time period when address was/is in use.
Requirements Allows addresses to be placed in historical context.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data type Period Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples General{
"start": "2010-03-23",
"end": "2010-07-01"
} Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|