SMART on FHIR Python Client 4.2.0
 
Loading...
Searching...
No Matches
fhirclient.models.appointment.Appointment Class Reference

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. More...

Inheritance diagram for fhirclient.models.appointment.Appointment:
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

 appointmentType
 
 basedOn
 
 cancelationReason
 
 comment
 
 created
 
 description
 
 end
 
 identifier
 
 minutesDuration
 
 participant
 
 patientInstruction
 
 priority
 
 reasonCode
 
 reasonReference
 
 requestedPeriod
 
 serviceCategory
 
 serviceType
 
 slot
 
 specialty
 
 start
 
 status
 
 supportingInformation
 
- 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 = "Appointment"
 
- 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

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time.

This may result in one or more Encounter(s).

Constructor & Destructor Documentation

◆ __init__()

fhirclient.models.appointment.Appointment.__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.appointment.Appointment.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

◆ appointmentType

fhirclient.models.appointment.Appointment.appointmentType

◆ basedOn

fhirclient.models.appointment.Appointment.basedOn

◆ cancelationReason

fhirclient.models.appointment.Appointment.cancelationReason

◆ comment

fhirclient.models.appointment.Appointment.comment

◆ created

fhirclient.models.appointment.Appointment.created

◆ description

fhirclient.models.appointment.Appointment.description

◆ end

fhirclient.models.appointment.Appointment.end

◆ identifier

fhirclient.models.appointment.Appointment.identifier

◆ minutesDuration

fhirclient.models.appointment.Appointment.minutesDuration

◆ participant

fhirclient.models.appointment.Appointment.participant

◆ patientInstruction

fhirclient.models.appointment.Appointment.patientInstruction

◆ priority

fhirclient.models.appointment.Appointment.priority

◆ reasonCode

fhirclient.models.appointment.Appointment.reasonCode

◆ reasonReference

fhirclient.models.appointment.Appointment.reasonReference

◆ requestedPeriod

fhirclient.models.appointment.Appointment.requestedPeriod

◆ resource_type

str fhirclient.models.appointment.Appointment.resource_type = "Appointment"
static

◆ serviceCategory

fhirclient.models.appointment.Appointment.serviceCategory

◆ serviceType

fhirclient.models.appointment.Appointment.serviceType

◆ slot

fhirclient.models.appointment.Appointment.slot

◆ specialty

fhirclient.models.appointment.Appointment.specialty

◆ start

fhirclient.models.appointment.Appointment.start

◆ status

fhirclient.models.appointment.Appointment.status

◆ supportingInformation

fhirclient.models.appointment.Appointment.supportingInformation

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