HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

AddressModel

Definitions for shr-core-Address-model.

shr-core-Address-model
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. (Source: HL7 FHIR).

Control0..*
shr-core-Address-model.purpose
Definition

Why the item is used.

Control0..1
BindingThe codes SHALL be taken from AddressUse
TypeCoding
shr-core-Address-model.type
Definition

The most specific code (lowest level term) describing the kind or sort of thing being represented.

Control0..1
BindingThe codes SHALL be taken from AddressType
TypeCoding
shr-core-Address-model.displayText
Definition

A string meant for reading by a person, for example, accompanying a code.

Control0..1
Typestring
shr-core-Address-model.addressLine
Definition

Part 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).

Control0..*
Typestring
shr-core-Address-model.city
Definition

The name of a municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR).

Control0..1
Typestring
shr-core-Address-model.district
Definition

The 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).

Control0..1
Typestring
shr-core-Address-model.state
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 (i.e. US 2 letter state codes). (Source: HL7 FHIR).

Control0..1
Typestring
shr-core-Address-model.postalCode
Definition

A sequence of letters and digits used as part of a postal address, often designating a geographic region

Control0..1
Typestring
shr-core-Address-model.country
Definition

Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes.

Control0..1
Typestring
shr-core-Address-model.effectiveTimePeriod
Definition

The date and time span for which something is active, valid, or in force.

Control0..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-EffectiveTimePeriod-model