SMART on FHIR Python Client 4.2.0
 
Loading...
Searching...
No Matches
fhirclient.models.researchstudy.ResearchStudy Class Reference

Investigation to increase healthcare-related patient-independent knowledge. More...

Inheritance diagram for fhirclient.models.researchstudy.ResearchStudy:
fhirclient.models.domainresource.DomainResource fhirclient.models.resource.Resource fhirclient.models.fhirabstractresource.FHIRAbstractResource fhirclient.models.fhirabstractbase.FHIRAbstractBase

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

 arm
 
 category
 
 condition
 
 contact
 
 description
 
 enrollment
 
 focus
 
 identifier
 
 keyword
 
 location
 
 note
 
 objective
 
 partOf
 
 period
 
 phase
 
 primaryPurposeType
 
 principalInvestigator
 
 protocol
 
 reasonStopped
 
 relatedArtifact
 
 site
 
 sponsor
 
 status
 
 title
 
- 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 = "ResearchStudy"
 
- 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

Investigation to increase healthcare-related patient-independent knowledge.

A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

Constructor & Destructor Documentation

◆ __init__()

fhirclient.models.researchstudy.ResearchStudy.__init__ (   self,
  jsondict = None,
  strict = True 
)

Initialize all valid properties.

   :raises: FHIRValidationError on validation errors, unless strict is False
Parameters
jsondictdict A JSON dictionary to use for initialization
strictbool If True (the default), invalid variables will raise a TypeError

Reimplemented from fhirclient.models.domainresource.DomainResource.

Member Function Documentation

◆ elementProperties()

fhirclient.models.researchstudy.ResearchStudy.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

◆ arm

fhirclient.models.researchstudy.ResearchStudy.arm

◆ category

fhirclient.models.researchstudy.ResearchStudy.category

◆ condition

fhirclient.models.researchstudy.ResearchStudy.condition

◆ contact

fhirclient.models.researchstudy.ResearchStudy.contact

◆ description

fhirclient.models.researchstudy.ResearchStudy.description

◆ enrollment

fhirclient.models.researchstudy.ResearchStudy.enrollment

◆ focus

fhirclient.models.researchstudy.ResearchStudy.focus

◆ identifier

fhirclient.models.researchstudy.ResearchStudy.identifier

◆ keyword

fhirclient.models.researchstudy.ResearchStudy.keyword

◆ location

fhirclient.models.researchstudy.ResearchStudy.location

◆ note

fhirclient.models.researchstudy.ResearchStudy.note

◆ objective

fhirclient.models.researchstudy.ResearchStudy.objective

◆ partOf

fhirclient.models.researchstudy.ResearchStudy.partOf

◆ period

fhirclient.models.researchstudy.ResearchStudy.period

◆ phase

fhirclient.models.researchstudy.ResearchStudy.phase

◆ primaryPurposeType

fhirclient.models.researchstudy.ResearchStudy.primaryPurposeType

◆ principalInvestigator

fhirclient.models.researchstudy.ResearchStudy.principalInvestigator

◆ protocol

fhirclient.models.researchstudy.ResearchStudy.protocol

◆ reasonStopped

fhirclient.models.researchstudy.ResearchStudy.reasonStopped

◆ relatedArtifact

fhirclient.models.researchstudy.ResearchStudy.relatedArtifact

◆ resource_type

str fhirclient.models.researchstudy.ResearchStudy.resource_type = "ResearchStudy"
static

◆ site

fhirclient.models.researchstudy.ResearchStudy.site

◆ sponsor

fhirclient.models.researchstudy.ResearchStudy.sponsor

◆ status

fhirclient.models.researchstudy.ResearchStudy.status

◆ title

fhirclient.models.researchstudy.ResearchStudy.title

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