Extends the FHIRAbstractBase with server talking capabilities. More...

Inheritance diagram for fhirclient.models.fhirabstractresource.FHIRAbstractResource:

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

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

	relativeBase (self)

	relativePath (self)

	read (cls, rem_id, server)
	Read the resource with the given id from the given server.

	read_from (cls, path, server)
	Requests data from the given REST path on the server and creates an instance of the receiving class.

	createPath (self)
	Get the endpoint on the server for creating the resource.

	create (self, server)
	Attempt to create the receiver on the given server, using a POST command.

	update (self, server=None)
	Update the receiver's representation on the given server, issuing a PUT command.

	delete (self, server=None)
	Delete the receiver from the given server with a DELETE command.

	search (self, struct=None)
	Search can be started via a dictionary containing a search construct.

	where (cls, struct)
	Search can be started via a dictionary containing a search construct.

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.

	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.

	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
	id

	resource_type

Static Public Attributes
str	resource_type = 'FHIRAbstractResource'

Protected Member Functions
	_with_json_dict (cls, jsondict)
	Overridden to use a factory if called when "resourceType" is defined in the JSON but does not match the receiver's resource_type.

Protected Member Functions inherited from fhirclient.models.fhirabstractbase.FHIRAbstractBase
	_matches_type (self, value, typ)

Protected Attributes
	_server

Protected Attributes inherited from fhirclient.models.fhirabstractbase.FHIRAbstractBase
	_resolved

	_owner

Properties
	origin_server = property
	Walks the owner hierarchy until it finds an owner with a server.

Detailed Description

Extends the FHIRAbstractBase with server talking capabilities.

Constructor & Destructor Documentation

◆ init()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.__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

Reimplemented from fhirclient.models.fhirabstractbase.FHIRAbstractBase.

Member Function Documentation

◆ _with_json_dict()

fhirclient.models.fhirabstractresource.FHIRAbstractResource._with_json_dict	(	cls,
		jsondict
	)

protected

Overridden to use a factory if called when "resourceType" is defined in the JSON but does not match the receiver's resource_type.

Reimplemented from fhirclient.models.fhirabstractbase.FHIRAbstractBase.

◆ as_json()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.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 from fhirclient.models.fhirabstractbase.FHIRAbstractBase.

◆ create()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.create	(	self,
		server
	)

Attempt to create the receiver on the given server, using a POST command.

Parameters

server FHIRServer The server to create the receiver on

Returns: s None or the response JSON on success

◆ createPath()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.createPath ( self )

Get the endpoint on the server for creating the resource.

Returns: s The resource endpoint or None for the root endpoint

◆ delete()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.delete	(	self,
		server = `None`
	)

Delete the receiver from the given server with a DELETE command.

Parameters

server FHIRServer The server to update the receiver on; optional, will use the instance's server if needed.

Returns: s None or the response JSON on success

◆ read()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.read	(	cls,
		rem_id,
		server
	)

Read the resource with the given id from the given server.

The passed-in server instance must support a request_json() method call, taking a relative path as first (and only mandatory) argument.

Parameters

rem_id	str The id of the resource on the remote server
server	FHIRServer An instance of a FHIR server or compatible class

Returns: s An instance of the receiving class

◆ read_from()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.read_from	(	cls,
		path,
		server
	)

Requests data from the given REST path on the server and creates an instance of the receiving class.

Parameters

path	str The REST path to read from
server	FHIRServer An instance of a FHIR server or compatible class

Returns: s An instance of the receiving class

◆ relativeBase()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.relativeBase ( self )

◆ relativePath()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.relativePath ( self )

◆ search()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.search	(	self,
		struct = `None`
	)

Search can be started via a dictionary containing a search construct.

Calling this method with a search struct will return a FHIRSearch object representing the search struct, with "$type" and "id" added.

Parameters

struct dict An optional search structure

Returns: s A FHIRSearch instance

◆ update()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.update	(	self,
		server = `None`
	)

Update the receiver's representation on the given server, issuing a PUT command.

Parameters

server FHIRServer The server to update the receiver on; optional, will use the instance's server if needed.

Returns: s None or the response JSON on success

◆ where()

fhirclient.models.fhirabstractresource.FHIRAbstractResource.where	(	cls,
		struct
	)

Search can be started via a dictionary containing a search construct.

Calling this method with a search struct will return a FHIRSearch object representing the search struct

Parameters

struct dict A search structure

Returns: s A FHIRSearch instance

Member Data Documentation

◆ _server

fhirclient.models.fhirabstractresource.FHIRAbstractResource._server

protected

◆ id

fhirclient.models.fhirabstractresource.FHIRAbstractResource.id

◆ resource_type [1/2]

str fhirclient.models.fhirabstractresource.FHIRAbstractResource.resource_type = 'FHIRAbstractResource'

static

◆ resource_type [2/2]

fhirclient.models.fhirabstractresource.FHIRAbstractResource.resource_type

Property Documentation

◆ origin_server

fhirclient.models.fhirabstractresource.FHIRAbstractResource.origin_server = property

static

Walks the owner hierarchy until it finds an owner with a server.

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

fhirclient/models/fhirabstractresource.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _with_json_dict()

◆ as_json()

◆ create()

◆ createPath()

◆ delete()

◆ read()

◆ read_from()

◆ relativeBase()

◆ relativePath()

◆ search()

◆ update()

◆ where()

Member Data Documentation

◆ _server

◆ id

◆ resource_type [1/2]

◆ resource_type [2/2]

Property Documentation

◆ origin_server

◆ init()