SMART on FHIR Python Client 4.2.0
 
Loading...
Searching...
No Matches
fhirclient.models.address.Address Class Reference

An address expressed using postal conventions (as opposed to GPS or other location definition formats). More...

Inheritance diagram for fhirclient.models.address.Address:
fhirclient.models.element.Element fhirclient.models.fhirabstractbase.FHIRAbstractBase

Public Member Functions

 __init__ (self, jsondict=None, strict=True)
 Initialize all valid properties.
 
 elementProperties (self)
 Returns a list of tuples, one tuple for each property that should be serialized, as: ("name", "json_name", type, is_list, "of_many", not_optional)
 
- Public Member Functions inherited from fhirclient.models.fhirabstractbase.FHIRAbstractBase
 with_json (cls, jsonobj)
 Initialize an element from a JSON dictionary or array.
 
 with_json_and_owner (cls, jsonobj, owner)
 Instantiates by forwarding to with_json(), then remembers the "owner" of the instantiated elements.
 
 update_with_json (self, jsondict)
 Update the receiver with data in a JSON dictionary.
 
 as_json (self)
 Serializes to JSON by inspecting elementProperties() and creating a JSON dictionary of all registered properties.
 
 owningResource (self)
 Walks the owner hierarchy and returns the next parent that is a DomainResource instance.
 
 owningBundle (self)
 Walks the owner hierarchy and returns the next parent that is a Bundle instance.
 
 resolvedReference (self, refid)
 Returns the resolved reference with the given id, if it has been resolved already.
 
 didResolveReference (self, refid, resolved)
 Called by FHIRResource when it resolves a reference.
 

Public Attributes

 city
 
 country
 
 district
 
 line
 
 period
 
 postalCode
 
 state
 
 text
 
 type
 
 use
 
- Public Attributes inherited from fhirclient.models.element.Element
 extension
 
 id
 

Static Public Attributes

str resource_type = "Address"
 
- Static Public Attributes inherited from fhirclient.models.element.Element
str resource_type = "Element"
 

Additional Inherited Members

- Protected Member Functions inherited from fhirclient.models.fhirabstractbase.FHIRAbstractBase
 _with_json_dict (cls, jsondict)
 Internal method to instantiate from JSON dictionary.
 
 _matches_type (self, value, typ)
 
- Protected Attributes inherited from fhirclient.models.fhirabstractbase.FHIRAbstractBase
 _resolved
 
 _owner
 

Detailed Description

An address expressed using postal conventions (as opposed to GPS or other location definition formats).

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.

Constructor & Destructor Documentation

◆ __init__()

fhirclient.models.address.Address.__init__ (   self,
  jsondict = None,
  strict = True 
)

Initialize all valid properties.

   :raises: FHIRValidationError on validation errors, unless strict is False
Parameters
jsondictdict A JSON dictionary to use for initialization
strictbool If True (the default), invalid variables will raise a TypeError

Reimplemented from fhirclient.models.element.Element.

Member Function Documentation

◆ elementProperties()

fhirclient.models.address.Address.elementProperties (   self)

Returns a list of tuples, one tuple for each property that should be serialized, as: ("name", "json_name", type, is_list, "of_many", not_optional)

Reimplemented from fhirclient.models.element.Element.

Member Data Documentation

◆ city

fhirclient.models.address.Address.city

◆ country

fhirclient.models.address.Address.country

◆ district

fhirclient.models.address.Address.district

◆ line

fhirclient.models.address.Address.line

◆ period

fhirclient.models.address.Address.period

◆ postalCode

fhirclient.models.address.Address.postalCode

◆ resource_type

str fhirclient.models.address.Address.resource_type = "Address"
static

◆ state

fhirclient.models.address.Address.state

◆ text

fhirclient.models.address.Address.text

◆ type

fhirclient.models.address.Address.type

◆ use

fhirclient.models.address.Address.use

The documentation for this class was generated from the following file: