Abstract base class for all FHIR elements. More...

Inheritance diagram for fhirclient.models.fhirabstractbase.FHIRAbstractBase:

Public Member Functions
	__init__ (self, jsondict=None, strict=True)
	Initializer.

	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.

	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)

	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.

Protected Member Functions
	_with_json_dict (cls, jsondict)
	Internal method to instantiate from JSON dictionary.

	_matches_type (self, value, typ)

Protected Attributes
	_resolved

	_owner

Detailed Description

Abstract base class for all FHIR elements.

Constructor & Destructor Documentation

◆ init()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.__init__	(	self,
		jsondict = `None`,
		strict = `True`
	)

Initializer.

If strict is true, raises on errors, otherwise uses logger.warning().

:raises: FHIRValidationError on validation errors, unless strict is False

Parameters

jsondict	dict A JSON dictionary to use for initialization
strict	bool If True (the default), invalid variables will raise a TypeError

Member Function Documentation

◆ _matches_type()

fhirclient.models.fhirabstractbase.FHIRAbstractBase._matches_type	(	self,
		value,
		typ
	)

protected

◆ _with_json_dict()

fhirclient.models.fhirabstractbase.FHIRAbstractBase._with_json_dict	(	cls,
		jsondict
	)

protected

Internal method to instantiate from JSON dictionary.

   :raises: TypeError on anything but dict
   :raises: FHIRValidationError if instantiation fails

Returns: s An instance created from dictionary data

Reimplemented in fhirclient.models.fhirabstractresource.FHIRAbstractResource.

◆ as_json()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.as_json ( self )

Serializes to JSON by inspecting elementProperties() and creating a JSON dictionary of all registered properties.

Checks:

whether required properties are not None (and lists not empty)
whether not-None properties are of the correct type

:raises: FHIRValidationError if properties have the wrong type or if required properties are empty

Returns: s A validated dict object that can be JSON serialized

Reimplemented in fhirclient.models.fhirabstractresource.FHIRAbstractResource.

◆ didResolveReference()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.didResolveReference	(	self,
		refid,
		resolved
	)

Called by FHIRResource when it resolves a reference.

Stores the resolved reference into the _resolved dictionary.

Parameters

refid	The id of the resource that was resolved
refid	The resolved resource, ready to be cached

◆ elementProperties()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.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)

◆ owningBundle()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.owningBundle ( self )

Walks the owner hierarchy and returns the next parent that is a Bundle instance.

◆ owningResource()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.owningResource ( self )

Walks the owner hierarchy and returns the next parent that is a DomainResource instance.

◆ resolvedReference()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.resolvedReference	(	self,
		refid
	)

Returns the resolved reference with the given id, if it has been resolved already.

If it hasn't, forwards the call to its owner if it has one.

You should probably use resolve() on the FHIRReference itself.

Parameters

refid The id of the resource to resolve

Returns: s An instance of Resource, if it was found

◆ update_with_json()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.update_with_json	(	self,
		jsondict
	)

Update the receiver with data in a JSON dictionary.

   :raises: FHIRValidationError on validation errors

Parameters

jsondict dict The JSON dictionary to use to update the receiver

Returns: s None on success, a list of errors if there were errors

◆ with_json()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.with_json	(	cls,
		jsonobj
	)

Initialize an element from a JSON dictionary or array.

   If the JSON dictionary has a "resourceType" entry and the specified
   resource type is not the receiving classes type, uses
   `FHIRElementFactory` to return a correct class instance.

   :raises: TypeError on anything but dict or list of dicts
   :raises: FHIRValidationError if instantiation fails

Parameters

jsonobj A dict or list of dicts to instantiate from

Returns: s An instance or a list of instances created from JSON data

◆ with_json_and_owner()

fhirclient.models.fhirabstractbase.FHIRAbstractBase.with_json_and_owner	(	cls,
		jsonobj,
		owner
	)

Instantiates by forwarding to with_json(), then remembers the "owner" of the instantiated elements.

The "owner" is the resource containing the receiver and is used to resolve contained resources.

:raises: TypeError on anything but dict or list of dicts :raises: FHIRValidationError if instantiation fails

Parameters

jsonobj	dict Decoded JSON dictionary (or list thereof)
owner	FHIRElement The owning parent

Returns: s An instance or a list of instances created from JSON data

Member Data Documentation

◆ _owner

fhirclient.models.fhirabstractbase.FHIRAbstractBase._owner

protected

◆ _resolved

fhirclient.models.fhirabstractbase.FHIRAbstractBase._resolved

protected

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

fhirclient/models/fhirabstractbase.py

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _matches_type()

◆ _with_json_dict()

◆ as_json()

◆ didResolveReference()

◆ elementProperties()

◆ owningBundle()

◆ owningResource()

◆ resolvedReference()

◆ update_with_json()

◆ with_json()

◆ with_json_and_owner()

Member Data Documentation

◆ _owner

◆ _resolved

◆ init()