Data Model Libraries
    Preparing search index...

    Class Address

    Address Class

    Address Type: 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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

    Need to be able to record postal addresses, along with notes about their use.

    FHIR Specification

    • Short: 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. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
    • Comment: 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).
    • FHIR Version: 5.0.0

    FHIR Address

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    addressUseEnum use? addressTypeEnum type_? text? line? city? district? state? postalCode? country? period?

    Methods

    parse getUseEnumType setUseEnumType hasUseEnumType getUseElement setUseElement hasUseElement getUse setUse hasUse getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getTextElement setTextElement hasTextElement getText setText hasText getLineElement setLineElement addLineElement hasLineElement getLine setLine addLine hasLine getCityElement setCityElement hasCityElement getCity setCity hasCity getDistrictElement setDistrictElement hasDistrictElement getDistrict setDistrict hasDistrict getStateElement setStateElement hasStateElement getState setState hasState getPostalCodeElement setPostalCodeElement hasPostalCodeElement getPostalCode setPostalCode hasPostalCode getCountryElement setCountryElement hasCountryElement getCountry setCountry hasCountry getPeriod setPeriod hasPeriod fhirType isEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initLine

    Constructors

    Properties

    addressUseEnum: AddressUseEnum

    FHIR CodeSystem: AddressUse

    AddressUseEnum

    use?: EnumCodeType

    Address.use Element

    FHIR Specification

    • Short: home | work | temp | old | billing - purpose of this address
    • Definition: The purpose of this address.
    • Comment: Applications can assume that an address is current unless it explicitly says that it is temporary or old.
    • Requirements: Allows an appropriate address to be chosen from a list of many.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
    • isSummary: true

    CodeSystem Enumeration: AddressUseEnum

    addressTypeEnum: AddressTypeEnum

    FHIR CodeSystem: AddressType

    AddressTypeEnum

    Private Optionaltype_

    type_?: EnumCodeType

    Address.type Element

    FHIR Specification

    • Short: 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.
    • Comment: 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).
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AddressTypeEnum

    Private Optionaltext

    text?: StringType

    Address.text Element

    FHIR Specification

    • Short: 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.
    • Comment: 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.
    • Requirements: A renderable, unencoded form.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    line?: StringType[]

    Address.line Element

    FHIR Specification

    • Short: 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.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    city?: StringType

    Address.city Element

    FHIR Specification

    • Short: Name of city, town etc.
    • Definition: The name of the city, town, suburb, village or other community or delivery center.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    district?: StringType

    Address.district Element

    FHIR Specification

    • Short: District name (aka county)
    • Definition: The name of the administrative area (county).
    • Comment: 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    state?: StringType

    Address.state Element

    FHIR Specification

    • Short: Sub-unit of country (abbreviations ok)
    • 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).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    postalCode?: StringType

    Address.postalCode Element

    FHIR Specification

    • Short: Postal code for area
    • Definition: A postal code designating a region defined by the postal service.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    country?: StringType

    Address.country Element

    FHIR Specification

    • Short: Country (e.g. may be ISO 3166 2 or 3 letter code)
    • Definition: Country - a nation as commonly understood or generally accepted.
    • Comment: ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    Address.period Element

    FHIR Specification

    • Short: 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.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided Address JSON to instantiate the Address data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Address

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Address

      Returns undefined | Address

      Address data model or undefined for Address

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUseEnumTypesetUseEnumTypehasUseEnumTypegetUseElementsetUseElementhasUseElementgetUsesetUsehasUsegetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetTextElementsetTextElementhasTextElementgetTextsetTexthasTextgetLineElementsetLineElementaddLineElementhasLineElementgetLinesetLineaddLinehasLinegetCityElementsetCityElementhasCityElementgetCitysetCityhasCitygetDistrictElementsetDistrictElementhasDistrictElementgetDistrictsetDistricthasDistrictgetStateElementsetStateElementhasStateElementgetStatesetStatehasStategetPostalCodeElementsetPostalCodeElementhasPostalCodeElementgetPostalCodesetPostalCodehasPostalCodegetCountryElementsetCountryElementhasCountryElementgetCountrysetCountryhasCountrygetPeriodsetPeriodhasPeriodfhirTypeisEmptycopyisComplexDataTypedataTypeNametoJSONisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitLine