Address

$10 / year

An address expressed using postal conventions (as opposed to Global Positioning System (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.

Complexity

An 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.

The text element 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. Applications updating an address shall ensure that when both text and parts are present, no content is included in the text that is not found in a part.

Address is used in the following places:
– Claim
– Claim Response
– Explanation of Benefit
– Insurance Plan
– Location
– Organization
– Patient
– Person
– Practitioner
– Related Person

Date Created

2018-09-20

Last Modified

2018-12-27

Version

4.0.0

Update Frequency

Annual

Temporal Coverage

N/A

Spatial Coverage

United States

Source

John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements

N/A

Source Citation

N/A

Keywords

FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Address Datatype, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structure.stringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its use.string-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
EnumThe enum is used to restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItemsEnum
Addressid#/definitions/stringUnique ID for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AddressextensionarrayMaybe 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.{'$ref': '#/definitions/Extension'}
AddressuseThe purpose of this address.['home', 'work', 'temp', 'old', 'billing']
Address_use#/definitions/ElementExtensions for use
AddresstypeDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.['postal', 'physical', 'both']
Address_type#/definitions/ElementExtensions for type
Addresstext#/definitions/stringSpecifies 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.
Address_text#/definitions/ElementExtensions for text
AddresslinearrayThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.{'$ref': '#/definitions/string'}
Address_linearrayExtensions for line{'$ref': '#/definitions/Element'}
Related Data Packages