HS.FHIRModel.R4.Address

class HS.FHIRModel.R4.Address extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Address generated class schema
*****************************************
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.

Property Inventory

• _city
• _country
• _district
• _line
• _postalCode
• _state
• _text
• _type
• _use
• city
• country
• district
• extension
• fhirID
• line
• period
• postalCode
• state
• text
• type
• use

Method Inventory

• IncludeExtension()
• IncludeLine()
• IncludePeriod()
• _getProperties()
• fromDao()
• toDao()

Parameters

parameter XMLTYPE = R4_ADDRESS;

Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _city as HS.FHIRModel.R4.Element;

Extensions for city

Property methods: _cityGet(), _cityGetSwizzled(), _cityIsValid(), _cityNewObject(), _citySet()

property _country as HS.FHIRModel.R4.Element;

Extensions for country

Property methods: _countryGet(), _countryGetSwizzled(), _countryIsValid(), _countryNewObject(), _countrySet()

property _district as HS.FHIRModel.R4.Element;

Extensions for district

Property methods: _districtGet(), _districtGetSwizzled(), _districtIsValid(), _districtNewObject(), _districtSet()

property _line as HS.FHIRModel.R4.SeqOfElement;

Extensions for line

Property methods: _lineGet(), _lineGetSwizzled(), _lineIsValid(), _lineNewObject(), _lineSet()

property _postalCode as HS.FHIRModel.R4.Element;

Extensions for postalCode

Property methods: _postalCodeGet(), _postalCodeGetSwizzled(), _postalCodeIsValid(), _postalCodeNewObject(), _postalCodeSet()

property _state as HS.FHIRModel.R4.Element;

Extensions for state

Property methods: _stateGet(), _stateGetSwizzled(), _stateIsValid(), _stateNewObject(), _stateSet()

property _text as HS.FHIRModel.R4.Element;

Extensions for text

Property methods: _textGet(), _textGetSwizzled(), _textIsValid(), _textNewObject(), _textSet()

property _type as HS.FHIRModel.R4.Element;

Extensions for type

Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()

property _use as HS.FHIRModel.R4.Element;

Extensions for use

Property methods: _useGet(), _useGetSwizzled(), _useIsValid(), _useNewObject(), _useSet()

property city as %String;

The name of the city, town, suburb, village or other community or delivery center.

Property methods: cityDisplayToLogical(), cityGet(), cityIsValid(), cityLogicalToDisplay(), cityLogicalToOdbc(), cityNormalize(), citySet()

property country as %String;

Country - a nation as commonly understood or generally accepted.

Property methods: countryDisplayToLogical(), countryGet(), countryIsValid(), countryLogicalToDisplay(), countryLogicalToOdbc(), countryNormalize(), countrySet()

property district as %String;

The name of the administrative area (county).

Property methods: districtDisplayToLogical(), districtGet(), districtIsValid(), districtLogicalToDisplay(), districtLogicalToOdbc(), districtNormalize(), districtSet()

property extension as HS.FHIRModel.R4.SeqOfExtension;

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.

Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()

property fhirID as %String;

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()

property line as HS.FHIRModel.R4.SeqOfString;

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Property methods: lineGet(), lineGetSwizzled(), lineIsValid(), lineNewObject(), lineSet()

property period as HS.FHIRModel.R4.Period;

Time period when address was/is in use.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()

property postalCode as %String;

A postal code designating a region defined by the postal service.

Property methods: postalCodeDisplayToLogical(), postalCodeGet(), postalCodeIsValid(), postalCodeLogicalToDisplay(), postalCodeLogicalToOdbc(), postalCodeNormalize(), postalCodeSet()

property state as %String;

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

Property methods: stateDisplayToLogical(), stateGet(), stateIsValid(), stateLogicalToDisplay(), stateLogicalToOdbc(), stateNormalize(), stateSet()

property text as %String;

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.

Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()

property type as %String (VALUELIST = ",postal,physical,both");

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

property use as %String (VALUELIST = ",home,work,temp,old,billing");

The purpose of this address.

Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()

Methods

method IncludeExtension()

method IncludeLine()

method IncludePeriod()

method _getProperties() as %DynamicArray

Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document

classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Address

method toDao() as %DynamicAbstractObject

Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

• %AddToSaveSet()
• %ClassIsLatestVersion()
• %ClassName()
• %ConstructClone()
• %DispatchClassMethod()
• %DispatchGetModified()
• %DispatchGetProperty()
• %DispatchMethod()
• %DispatchSetModified()
• %DispatchSetMultidimProperty()
• %DispatchSetProperty()
• %Extends()
• %GetParameter()
• %IsA()
• %IsModified()
• %New()
• %NormalizeObject()
• %ObjectModified()
• %OriginalNamespace()
• %PackageName()
• %RemoveFromSaveSet()
• %SerializeObject()
• %SetModified()
• %ValidateObject()
• XMLDTD()
• XMLExport()
• XMLExportToStream()
• XMLExportToString()
• XMLNew()
• XMLSchema()
• XMLSchemaNamespace()
• XMLSchemaType()
• add()
• addAll()
• apply()
• clear()
• contains()
• containsAll()
• get()
• iterator()
• put()
• putAll()
• putAllIfAbsent()
• putIfAbsent()
• remove()
• removeAll()
• removeIf()
• rename()
• replace()
• replaceAll()
• size()
• toString()