fhirclient.models.searchparameter.SearchParameter Class Reference

Search parameter for a resource. More...

Inheritance diagram for fhirclient.models.searchparameter.SearchParameter:

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.fhirabstractresource.FHIRAbstractResource
	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.
	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
	base
	chain
	code
	comparator
	component
	contact
	date
	derivedFrom
	description
	experimental
	expression
	jurisdiction
	modifier
	multipleAnd
	multipleOr
	name
	publisher
	purpose
	status
	target
	type
	url
	useContext
	version
	xpath
	xpathUsage
Public Attributes inherited from fhirclient.models.domainresource.DomainResource
	contained
	extension
	modifierExtension
	text
Public Attributes inherited from fhirclient.models.resource.Resource
	id
	implicitRules
	language
	meta
Public Attributes inherited from fhirclient.models.fhirabstractresource.FHIRAbstractResource
	id
	resource_type

Static Public Attributes
str	resource_type = "SearchParameter"
Static Public Attributes inherited from fhirclient.models.domainresource.DomainResource
str	resource_type = "DomainResource"
Static Public Attributes inherited from fhirclient.models.resource.Resource
str	resource_type = "Resource"
Static Public Attributes inherited from fhirclient.models.fhirabstractresource.FHIRAbstractResource
str	resource_type = 'FHIRAbstractResource'

Additional Inherited Members
Protected Member Functions inherited from fhirclient.models.fhirabstractresource.FHIRAbstractResource
	_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 inherited from fhirclient.models.fhirabstractresource.FHIRAbstractResource
	_server
Protected Attributes inherited from fhirclient.models.fhirabstractbase.FHIRAbstractBase
	_resolved
	_owner
Properties inherited from fhirclient.models.fhirabstractresource.FHIRAbstractResource
	origin_server = property
	Walks the owner hierarchy until it finds an owner with a server.

Detailed Description

Search parameter for a resource.

A search parameter that defines a named search item that can be used to search/filter on a resource.

Constructor & Destructor Documentation

__init__()

fhirclient.models.searchparameter.SearchParameter.__init__	(		self,
			jsondict = None,
			strict = True
	)

Initialize all valid properties.

   :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.domainresource.DomainResource.

Member Function Documentation

elementProperties()

fhirclient.models.searchparameter.SearchParameter.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.domainresource.DomainResource.

Member Data Documentation

base

fhirclient.models.searchparameter.SearchParameter.base

chain

fhirclient.models.searchparameter.SearchParameter.chain

code

fhirclient.models.searchparameter.SearchParameter.code

comparator

fhirclient.models.searchparameter.SearchParameter.comparator

component

fhirclient.models.searchparameter.SearchParameter.component

contact

fhirclient.models.searchparameter.SearchParameter.contact

date

fhirclient.models.searchparameter.SearchParameter.date

derivedFrom

fhirclient.models.searchparameter.SearchParameter.derivedFrom

description

fhirclient.models.searchparameter.SearchParameter.description

experimental

fhirclient.models.searchparameter.SearchParameter.experimental

expression

fhirclient.models.searchparameter.SearchParameter.expression

jurisdiction

fhirclient.models.searchparameter.SearchParameter.jurisdiction

modifier

fhirclient.models.searchparameter.SearchParameter.modifier

multipleAnd

fhirclient.models.searchparameter.SearchParameter.multipleAnd

multipleOr

fhirclient.models.searchparameter.SearchParameter.multipleOr

name

fhirclient.models.searchparameter.SearchParameter.name

publisher

fhirclient.models.searchparameter.SearchParameter.publisher

purpose

fhirclient.models.searchparameter.SearchParameter.purpose

resource_type

str fhirclient.models.searchparameter.SearchParameter.resource_type = "SearchParameter"

static

status

fhirclient.models.searchparameter.SearchParameter.status

target

fhirclient.models.searchparameter.SearchParameter.target

type

fhirclient.models.searchparameter.SearchParameter.type

url

fhirclient.models.searchparameter.SearchParameter.url

useContext

fhirclient.models.searchparameter.SearchParameter.useContext

version

fhirclient.models.searchparameter.SearchParameter.version

xpath

fhirclient.models.searchparameter.SearchParameter.xpath

xpathUsage

fhirclient.models.searchparameter.SearchParameter.xpathUsage

---

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

• fhirclient/models/searchparameter.py