HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

AddressModel

 

The official URL for this logical model is: 

http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-model

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. (Source: HL7 FHIR).

This logical model was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by HL7.

This IG does not define a corresponding profile for this logical model.

NameFlagsCard.TypeDescription & Constraintsdoco
.. shr-core-Address-model 0..*
... purpose 0..1CodingWhy the item is used.
Binding: AddressUse (required)
... type 0..1CodingThe most specific code (lowest level term) describing the kind or sort of thing being represented.
Binding: AddressType (required)
... displayText 0..1stringA string meant for reading by a person, for example, accompanying a code.
... addressLine 0..*stringPart of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR).
... city 0..1stringThe name of a municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR).
... district 0..1stringThe name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. Outside the US, a district or the equivalent. (Source: HL7 FHIR).
... state 0..1stringSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR).
... postalCode 0..1stringA sequence of letters and digits used as part of a postal address, often designating a geographic region
... country 0..1stringCountry - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes.
... effectiveTimePeriod 0..1EffectiveTimePeriodModelThe date and time span for which something is active, valid, or in force.

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL)

 

Terminology Bindings

PathNameConformanceValueSet
shr-core-Address-model.purposeAddressUserequiredAddressUse
shr-core-Address-model.typeAddressTyperequiredAddressType