SMART on FHIR Python Client 4.2.0
 
Loading...
Searching...
No Matches
fhirclient.models.substancesourcematerial.SubstanceSourceMaterial Class Reference

Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. More...

Inheritance diagram for fhirclient.models.substancesourcematerial.SubstanceSourceMaterial:
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

 countryOfOrigin
 
 developmentStage
 
 fractionDescription
 
 geographicalLocation
 
 organism
 
 organismId
 
 organismName
 
 parentSubstanceId
 
 parentSubstanceName
 
 partDescription
 
 sourceMaterialClass
 
 sourceMaterialState
 
 sourceMaterialType
 
- 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 = "SubstanceSourceMaterial"
 
- 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

Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance.

This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.

Constructor & Destructor Documentation

◆ __init__()

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.__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.substancesourcematerial.SubstanceSourceMaterial.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

◆ countryOfOrigin

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.countryOfOrigin

◆ developmentStage

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.developmentStage

◆ fractionDescription

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.fractionDescription

◆ geographicalLocation

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.geographicalLocation

◆ organism

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.organism

◆ organismId

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.organismId

◆ organismName

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.organismName

◆ parentSubstanceId

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.parentSubstanceId

◆ parentSubstanceName

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.parentSubstanceName

◆ partDescription

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.partDescription

◆ resource_type

str fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.resource_type = "SubstanceSourceMaterial"
static

◆ sourceMaterialClass

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.sourceMaterialClass

◆ sourceMaterialState

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.sourceMaterialState

◆ sourceMaterialType

fhirclient.models.substancesourcematerial.SubstanceSourceMaterial.sourceMaterialType

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