The definition of a plan for a series of actions, independent of any specific patient or context. More...

Inheritance diagram for fhirclient.models.plandefinition.PlanDefinition:

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
	action

	approvalDate

	author

	contact

	copyright

	date

	description

	editor

	effectivePeriod

	endorser

	experimental

	goal

	identifier

	jurisdiction

	lastReviewDate

	library

	name

	publisher

	purpose

	relatedArtifact

	reviewer

	status

	subjectCodeableConcept

	subjectReference

	subtitle

	title

	topic

	type

	url

	usage

	useContext

	version

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 = "PlanDefinition"

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

The definition of a plan for a series of actions, independent of any specific patient or context.

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

Constructor & Destructor Documentation

◆ init()

fhirclient.models.plandefinition.PlanDefinition.__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.plandefinition.PlanDefinition.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

◆ action

fhirclient.models.plandefinition.PlanDefinition.action

◆ approvalDate

fhirclient.models.plandefinition.PlanDefinition.approvalDate

◆ author

fhirclient.models.plandefinition.PlanDefinition.author

◆ contact

fhirclient.models.plandefinition.PlanDefinition.contact

◆ copyright

fhirclient.models.plandefinition.PlanDefinition.copyright

◆ date

fhirclient.models.plandefinition.PlanDefinition.date

◆ description

fhirclient.models.plandefinition.PlanDefinition.description

◆ editor

fhirclient.models.plandefinition.PlanDefinition.editor

◆ effectivePeriod

fhirclient.models.plandefinition.PlanDefinition.effectivePeriod

◆ endorser

fhirclient.models.plandefinition.PlanDefinition.endorser

◆ experimental

fhirclient.models.plandefinition.PlanDefinition.experimental

◆ goal

fhirclient.models.plandefinition.PlanDefinition.goal

◆ identifier

fhirclient.models.plandefinition.PlanDefinition.identifier

◆ jurisdiction

fhirclient.models.plandefinition.PlanDefinition.jurisdiction

◆ lastReviewDate

fhirclient.models.plandefinition.PlanDefinition.lastReviewDate

◆ library

fhirclient.models.plandefinition.PlanDefinition.library

◆ name

fhirclient.models.plandefinition.PlanDefinition.name

◆ publisher

fhirclient.models.plandefinition.PlanDefinition.publisher

◆ purpose

fhirclient.models.plandefinition.PlanDefinition.purpose

◆ relatedArtifact

fhirclient.models.plandefinition.PlanDefinition.relatedArtifact

◆ resource_type

str fhirclient.models.plandefinition.PlanDefinition.resource_type = "PlanDefinition"

static

◆ reviewer

fhirclient.models.plandefinition.PlanDefinition.reviewer

◆ status

fhirclient.models.plandefinition.PlanDefinition.status

◆ subjectCodeableConcept

fhirclient.models.plandefinition.PlanDefinition.subjectCodeableConcept

◆ subjectReference

fhirclient.models.plandefinition.PlanDefinition.subjectReference

◆ subtitle

fhirclient.models.plandefinition.PlanDefinition.subtitle

◆ title

fhirclient.models.plandefinition.PlanDefinition.title

◆ topic

fhirclient.models.plandefinition.PlanDefinition.topic

◆ type

fhirclient.models.plandefinition.PlanDefinition.type

◆ url

fhirclient.models.plandefinition.PlanDefinition.url

◆ usage

fhirclient.models.plandefinition.PlanDefinition.usage

◆ useContext

fhirclient.models.plandefinition.PlanDefinition.useContext

◆ version

fhirclient.models.plandefinition.PlanDefinition.version

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

fhirclient/models/plandefinition.py

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members