SMART on FHIR Python Client  3.0.0
fhirclient.models.structuredefinition.StructureDefinition Class Reference

Structural Definition. More...

Inheritance diagram for fhirclient.models.structuredefinition.StructureDefinition:
fhirclient.models.domainresource.DomainResource fhirclient.models.resource.Resource fhirclient.models.fhirabstractresource.FHIRAbstractResource fhirclient.models.fhirabstractbase.FHIRAbstractBase

Public Member Functions

def __init__ (self, jsondict=None, strict=True)
 Initialize all valid properties. More...
 
def elementProperties (self)
 
- Public Member Functions inherited from fhirclient.models.domainresource.DomainResource
def __init__ (self, jsondict=None, strict=True)
 Initialize all valid properties. More...
 
def elementProperties (self)
 
- Public Member Functions inherited from fhirclient.models.resource.Resource
def __init__ (self, jsondict=None, strict=True)
 Initialize all valid properties. More...
 
def elementProperties (self)
 
- Public Member Functions inherited from fhirclient.models.fhirabstractresource.FHIRAbstractResource
def __init__ (self, jsondict=None, strict=True)
 
def as_json (self)
 
def relativeBase (self)
 
def relativePath (self)
 
def server (self)
 Walks the owner hierarchy until it finds an owner with a server. More...
 
def read (cls, rem_id, server)
 Read the resource with the given id from the given server. More...
 
def read_from (cls, path, server)
 Requests data from the given REST path on the server and creates an instance of the receiving class. More...
 
def create (self, server)
 Attempt to create the receiver on the given server, using a POST command. More...
 
def update (self, server=None)
 Update the receiver's representation on the given server, issuing a PUT command. More...
 
def delete (self, server=None)
 Delete the receiver from the given server with a DELETE command. More...
 
def search (self, struct=None)
 Search can be started via a dictionary containing a search construct. More...
 
def where (cls, struct)
 Search can be started via a dictionary containing a search construct. More...
 
- Public Member Functions inherited from fhirclient.models.fhirabstractbase.FHIRAbstractBase
def __init__ (self, jsondict=None, strict=True)
 Initializer. More...
 
def with_json (cls, jsonobj)
 Initialize an element from a JSON dictionary or array. More...
 
def with_json_and_owner (cls, jsonobj, owner)
 Instantiates by forwarding to with_json(), then remembers the "owner" of the instantiated elements. More...
 
def 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) More...
 
def update_with_json (self, jsondict)
 Update the receiver with data in a JSON dictionary. More...
 
def as_json (self)
 Serializes to JSON by inspecting elementProperties() and creating a JSON dictionary of all registered properties. More...
 
def owningResource (self)
 Walks the owner hierarchy and returns the next parent that is a DomainResource instance. More...
 
def owningBundle (self)
 Walks the owner hierarchy and returns the next parent that is a Bundle instance. More...
 
def resolvedReference (self, refid)
 Returns the resolved reference with the given id, if it has been resolved already. More...
 
def didResolveReference (self, refid, resolved)
 Called by FHIRResource when it resolves a reference. More...
 

Public Attributes

 abstract
 
 baseDefinition
 
 contact
 
 context
 
 contextInvariant
 
 contextType
 
 copyright
 
 date
 
 derivation
 
 description
 
 differential
 
 experimental
 
 fhirVersion
 
 identifier
 
 jurisdiction
 
 keyword
 
 kind
 
 mapping
 
 name
 
 publisher
 
 purpose
 
 snapshot
 
 status
 
 title
 
 type
 
 url
 
 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
 

Static Public Attributes

string resource_type = "StructureDefinition"
 
- Static Public Attributes inherited from fhirclient.models.domainresource.DomainResource
string resource_type = "DomainResource"
 
- Static Public Attributes inherited from fhirclient.models.resource.Resource
string resource_type = "Resource"
 
- Static Public Attributes inherited from fhirclient.models.fhirabstractresource.FHIRAbstractResource
string resource_type = 'FHIRAbstractResource'
 

Detailed Description

Structural Definition.

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Constructor & Destructor Documentation

def fhirclient.models.structuredefinition.StructureDefinition.__init__ (   self,
  jsondict = None,
  strict = True 
)

Initialize all valid properties.

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

Member Function Documentation

def fhirclient.models.structuredefinition.StructureDefinition.elementProperties (   self)

Member Data Documentation

fhirclient.models.structuredefinition.StructureDefinition.abstract
fhirclient.models.structuredefinition.StructureDefinition.baseDefinition
fhirclient.models.structuredefinition.StructureDefinition.contact
fhirclient.models.structuredefinition.StructureDefinition.context
fhirclient.models.structuredefinition.StructureDefinition.contextInvariant
fhirclient.models.structuredefinition.StructureDefinition.contextType
fhirclient.models.structuredefinition.StructureDefinition.copyright
fhirclient.models.structuredefinition.StructureDefinition.date
fhirclient.models.structuredefinition.StructureDefinition.derivation
fhirclient.models.structuredefinition.StructureDefinition.description
fhirclient.models.structuredefinition.StructureDefinition.differential
fhirclient.models.structuredefinition.StructureDefinition.experimental
fhirclient.models.structuredefinition.StructureDefinition.fhirVersion
fhirclient.models.structuredefinition.StructureDefinition.identifier
fhirclient.models.structuredefinition.StructureDefinition.jurisdiction
fhirclient.models.structuredefinition.StructureDefinition.keyword
fhirclient.models.structuredefinition.StructureDefinition.kind
fhirclient.models.structuredefinition.StructureDefinition.mapping
fhirclient.models.structuredefinition.StructureDefinition.name
fhirclient.models.structuredefinition.StructureDefinition.publisher
fhirclient.models.structuredefinition.StructureDefinition.purpose
string fhirclient.models.structuredefinition.StructureDefinition.resource_type = "StructureDefinition"
static
fhirclient.models.structuredefinition.StructureDefinition.snapshot
fhirclient.models.structuredefinition.StructureDefinition.status
fhirclient.models.structuredefinition.StructureDefinition.title
fhirclient.models.structuredefinition.StructureDefinition.type
fhirclient.models.structuredefinition.StructureDefinition.url
fhirclient.models.structuredefinition.StructureDefinition.useContext
fhirclient.models.structuredefinition.StructureDefinition.version

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