A reference to a document. More...

Inheritance diagram for fhirclient.models.documentreference.DocumentReference:

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
	authenticator

	author

	category

	content

	context

	custodian

	date

	description

	docStatus

	identifier

	masterIdentifier

	relatesTo

	securityLabel

	status

	subject

	type

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

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

A reference to a document.

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Constructor & Destructor Documentation

◆ init()

fhirclient.models.documentreference.DocumentReference.__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.documentreference.DocumentReference.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

◆ authenticator

fhirclient.models.documentreference.DocumentReference.authenticator

◆ author

fhirclient.models.documentreference.DocumentReference.author

◆ category

fhirclient.models.documentreference.DocumentReference.category

◆ content

fhirclient.models.documentreference.DocumentReference.content

◆ context

fhirclient.models.documentreference.DocumentReference.context

◆ custodian

fhirclient.models.documentreference.DocumentReference.custodian

◆ date

fhirclient.models.documentreference.DocumentReference.date

◆ description

fhirclient.models.documentreference.DocumentReference.description

◆ docStatus

fhirclient.models.documentreference.DocumentReference.docStatus

◆ identifier

fhirclient.models.documentreference.DocumentReference.identifier

◆ masterIdentifier

fhirclient.models.documentreference.DocumentReference.masterIdentifier

◆ relatesTo

fhirclient.models.documentreference.DocumentReference.relatesTo

◆ resource_type

str fhirclient.models.documentreference.DocumentReference.resource_type = "DocumentReference"

static

◆ securityLabel

fhirclient.models.documentreference.DocumentReference.securityLabel

◆ status

fhirclient.models.documentreference.DocumentReference.status

◆ subject

fhirclient.models.documentreference.DocumentReference.subject

◆ type

fhirclient.models.documentreference.DocumentReference.type

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

fhirclient/models/documentreference.py

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members