SMART on FHIR Python Client 4.2.0
 
Loading...
Searching...
No Matches
fhirclient.models.codesystem.CodeSystem Class Reference

Declares the existence of and describes a code system or code system supplement. More...

Inheritance diagram for fhirclient.models.codesystem.CodeSystem:
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

 caseSensitive
 
 compositional
 
 concept
 
 contact
 
 content
 
 copyright
 
 count
 
 date
 
 description
 
 experimental
 
 filter
 
 hierarchyMeaning
 
 identifier
 
 jurisdiction
 
 name
 
 property
 
 publisher
 
 purpose
 
 status
 
 supplements
 
 title
 
 url
 
 useContext
 
 valueSet
 
 version
 
 versionNeeded
 
- 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 = "CodeSystem"
 
- 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

Declares the existence of and describes a code system or code system supplement.

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

Constructor & Destructor Documentation

◆ __init__()

fhirclient.models.codesystem.CodeSystem.__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.codesystem.CodeSystem.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

◆ caseSensitive

fhirclient.models.codesystem.CodeSystem.caseSensitive

◆ compositional

fhirclient.models.codesystem.CodeSystem.compositional

◆ concept

fhirclient.models.codesystem.CodeSystem.concept

◆ contact

fhirclient.models.codesystem.CodeSystem.contact

◆ content

fhirclient.models.codesystem.CodeSystem.content

◆ copyright

fhirclient.models.codesystem.CodeSystem.copyright

◆ count

fhirclient.models.codesystem.CodeSystem.count

◆ date

fhirclient.models.codesystem.CodeSystem.date

◆ description

fhirclient.models.codesystem.CodeSystem.description

◆ experimental

fhirclient.models.codesystem.CodeSystem.experimental

◆ filter

fhirclient.models.codesystem.CodeSystem.filter

◆ hierarchyMeaning

fhirclient.models.codesystem.CodeSystem.hierarchyMeaning

◆ identifier

fhirclient.models.codesystem.CodeSystem.identifier

◆ jurisdiction

fhirclient.models.codesystem.CodeSystem.jurisdiction

◆ name

fhirclient.models.codesystem.CodeSystem.name

◆ property

fhirclient.models.codesystem.CodeSystem.property

◆ publisher

fhirclient.models.codesystem.CodeSystem.publisher

◆ purpose

fhirclient.models.codesystem.CodeSystem.purpose

◆ resource_type

str fhirclient.models.codesystem.CodeSystem.resource_type = "CodeSystem"
static

◆ status

fhirclient.models.codesystem.CodeSystem.status

◆ supplements

fhirclient.models.codesystem.CodeSystem.supplements

◆ title

fhirclient.models.codesystem.CodeSystem.title

◆ url

fhirclient.models.codesystem.CodeSystem.url

◆ useContext

fhirclient.models.codesystem.CodeSystem.useContext

◆ valueSet

fhirclient.models.codesystem.CodeSystem.valueSet

◆ version

fhirclient.models.codesystem.CodeSystem.version

◆ versionNeeded

fhirclient.models.codesystem.CodeSystem.versionNeeded

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