SMART on FHIR Python Client  3.0.0
fhirclient.models.fhirabstractresource.FHIRAbstractResource Class Reference

Extends the FHIRAbstractBase with server talking capabilities. More...

Inheritance diagram for fhirclient.models.fhirabstractresource.FHIRAbstractResource:
fhirclient.models.fhirabstractbase.FHIRAbstractBase fhirclient.models.resource.Resource fhirclient.models.binary.Binary fhirclient.models.bundle.Bundle fhirclient.models.domainresource.DomainResource fhirclient.models.parameters.Parameters fhirclient.models.account.Account fhirclient.models.activitydefinition.ActivityDefinition fhirclient.models.adverseevent.AdverseEvent fhirclient.models.allergyintolerance.AllergyIntolerance fhirclient.models.appointment.Appointment fhirclient.models.appointmentresponse.AppointmentResponse fhirclient.models.auditevent.AuditEvent fhirclient.models.basic.Basic fhirclient.models.bodysite.BodySite fhirclient.models.capabilitystatement.CapabilityStatement fhirclient.models.careplan.CarePlan fhirclient.models.careteam.CareTeam fhirclient.models.chargeitem.ChargeItem fhirclient.models.claim.Claim fhirclient.models.claimresponse.ClaimResponse fhirclient.models.clinicalimpression.ClinicalImpression fhirclient.models.codesystem.CodeSystem fhirclient.models.communication.Communication fhirclient.models.communicationrequest.CommunicationRequest fhirclient.models.compartmentdefinition.CompartmentDefinition fhirclient.models.composition.Composition fhirclient.models.conceptmap.ConceptMap fhirclient.models.condition.Condition fhirclient.models.consent.Consent fhirclient.models.contract.Contract fhirclient.models.coverage.Coverage fhirclient.models.dataelement.DataElement fhirclient.models.detectedissue.DetectedIssue fhirclient.models.device.Device fhirclient.models.devicecomponent.DeviceComponent fhirclient.models.devicemetric.DeviceMetric fhirclient.models.devicerequest.DeviceRequest fhirclient.models.deviceusestatement.DeviceUseStatement fhirclient.models.diagnosticreport.DiagnosticReport fhirclient.models.documentmanifest.DocumentManifest fhirclient.models.documentreference.DocumentReference fhirclient.models.eligibilityrequest.EligibilityRequest fhirclient.models.eligibilityresponse.EligibilityResponse fhirclient.models.encounter.Encounter fhirclient.models.endpoint.Endpoint fhirclient.models.enrollmentrequest.EnrollmentRequest fhirclient.models.enrollmentresponse.EnrollmentResponse fhirclient.models.episodeofcare.EpisodeOfCare fhirclient.models.expansionprofile.ExpansionProfile fhirclient.models.explanationofbenefit.ExplanationOfBenefit fhirclient.models.familymemberhistory.FamilyMemberHistory fhirclient.models.flag.Flag fhirclient.models.goal.Goal fhirclient.models.graphdefinition.GraphDefinition fhirclient.models.group.Group fhirclient.models.guidanceresponse.GuidanceResponse fhirclient.models.healthcareservice.HealthcareService fhirclient.models.imagingmanifest.ImagingManifest fhirclient.models.imagingstudy.ImagingStudy fhirclient.models.immunization.Immunization fhirclient.models.immunizationrecommendation.ImmunizationRecommendation fhirclient.models.implementationguide.ImplementationGuide fhirclient.models.library.Library fhirclient.models.linkage.Linkage fhirclient.models.list.List fhirclient.models.location.Location fhirclient.models.measure.Measure fhirclient.models.measurereport.MeasureReport fhirclient.models.media.Media fhirclient.models.medication.Medication fhirclient.models.medicationadministration.MedicationAdministration fhirclient.models.medicationdispense.MedicationDispense fhirclient.models.medicationrequest.MedicationRequest fhirclient.models.medicationstatement.MedicationStatement fhirclient.models.messagedefinition.MessageDefinition fhirclient.models.messageheader.MessageHeader fhirclient.models.metadataresource.MetadataResource fhirclient.models.namingsystem.NamingSystem fhirclient.models.nutritionorder.NutritionOrder fhirclient.models.observation.Observation fhirclient.models.operationdefinition.OperationDefinition fhirclient.models.operationoutcome.OperationOutcome fhirclient.models.organization.Organization fhirclient.models.patient.Patient fhirclient.models.paymentnotice.PaymentNotice fhirclient.models.paymentreconciliation.PaymentReconciliation fhirclient.models.person.Person fhirclient.models.plandefinition.PlanDefinition fhirclient.models.practitioner.Practitioner fhirclient.models.practitionerrole.PractitionerRole fhirclient.models.procedure.Procedure fhirclient.models.procedurerequest.ProcedureRequest fhirclient.models.processrequest.ProcessRequest fhirclient.models.processresponse.ProcessResponse fhirclient.models.provenance.Provenance fhirclient.models.questionnaire.Questionnaire fhirclient.models.questionnaireresponse.QuestionnaireResponse fhirclient.models.referralrequest.ReferralRequest fhirclient.models.relatedperson.RelatedPerson fhirclient.models.requestgroup.RequestGroup fhirclient.models.researchstudy.ResearchStudy fhirclient.models.researchsubject.ResearchSubject fhirclient.models.riskassessment.RiskAssessment fhirclient.models.schedule.Schedule fhirclient.models.searchparameter.SearchParameter fhirclient.models.sequence.Sequence fhirclient.models.servicedefinition.ServiceDefinition fhirclient.models.slot.Slot fhirclient.models.specimen.Specimen fhirclient.models.structuredefinition.StructureDefinition fhirclient.models.structuremap.StructureMap fhirclient.models.subscription.Subscription fhirclient.models.substance.Substance fhirclient.models.supplydelivery.SupplyDelivery fhirclient.models.supplyrequest.SupplyRequest fhirclient.models.task.Task fhirclient.models.testreport.TestReport fhirclient.models.testscript.TestScript fhirclient.models.valueset.ValueSet fhirclient.models.visionprescription.VisionPrescription

Public Member Functions

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...
 

Static Public Attributes

string resource_type = 'FHIRAbstractResource'
 

Detailed Description

Extends the FHIRAbstractBase with server talking capabilities.

Constructor & Destructor Documentation

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.__init__ (   self,
  jsondict = None,
  strict = True 
)

Member Function Documentation

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.as_json (   self)
def fhirclient.models.fhirabstractresource.FHIRAbstractResource.create (   self,
  server 
)

Attempt to create the receiver on the given server, using a POST command.

:param FHIRServer server: The server to create the receiver on :returns: None or the response JSON on success

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.delete (   self,
  server = None 
)

Delete the receiver from the given server with a DELETE command.

:param FHIRServer server: The server to update the receiver on; optional, will use the instance's server if needed. :returns: None or the response JSON on success

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.read (   cls,
  rem_id,
  server 
)

Read the resource with the given id from the given server.

The passed-in server instance must support a request_json() method call, taking a relative path as first (and only mandatory) argument.

:param str rem_id: The id of the resource on the remote server :param FHIRServer server: An instance of a FHIR server or compatible class :returns: An instance of the receiving class

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.read_from (   cls,
  path,
  server 
)

Requests data from the given REST path on the server and creates an instance of the receiving class.

:param str path: The REST path to read from :param FHIRServer server: An instance of a FHIR server or compatible class :returns: An instance of the receiving class

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.relativeBase (   self)
def fhirclient.models.fhirabstractresource.FHIRAbstractResource.relativePath (   self)
def fhirclient.models.fhirabstractresource.FHIRAbstractResource.search (   self,
  struct = None 
)

Search can be started via a dictionary containing a search construct.

Calling this method with a search struct will return a FHIRSearch object representing the search struct, with "$type" and "id" added.

:param dict struct: An optional search structure :returns: A FHIRSearch instance

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.server (   self)

Walks the owner hierarchy until it finds an owner with a server.

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.update (   self,
  server = None 
)

Update the receiver's representation on the given server, issuing a PUT command.

:param FHIRServer server: The server to update the receiver on; optional, will use the instance's server if needed. :returns: None or the response JSON on success

def fhirclient.models.fhirabstractresource.FHIRAbstractResource.where (   cls,
  struct 
)

Search can be started via a dictionary containing a search construct.

Calling this method with a search struct will return a FHIRSearch object representing the search struct

:param dict struct: A search structure :returns: A FHIRSearch instance

Member Data Documentation

string fhirclient.models.fhirabstractresource.FHIRAbstractResource.resource_type = 'FHIRAbstractResource'
static

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