SMART on FHIR Python Client  3.0.0
fhirclient.models.messageheader.MessageHeader Class Reference

A resource that describes a message that is exchanged between systems. More...

Inheritance diagram for fhirclient.models.messageheader.MessageHeader:
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

 author
 
 destination
 
 enterer
 
 event
 
 focus
 
 reason
 
 receiver
 
 response
 
 responsible
 
 sender
 
 source
 
 timestamp
 
- 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 = "MessageHeader"
 
- 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

A resource that describes a message that is exchanged between systems.

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Constructor & Destructor Documentation

def fhirclient.models.messageheader.MessageHeader.__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.messageheader.MessageHeader.elementProperties (   self)

Member Data Documentation

fhirclient.models.messageheader.MessageHeader.author
fhirclient.models.messageheader.MessageHeader.destination
fhirclient.models.messageheader.MessageHeader.enterer
fhirclient.models.messageheader.MessageHeader.event
fhirclient.models.messageheader.MessageHeader.focus
fhirclient.models.messageheader.MessageHeader.reason
fhirclient.models.messageheader.MessageHeader.receiver
string fhirclient.models.messageheader.MessageHeader.resource_type = "MessageHeader"
static
fhirclient.models.messageheader.MessageHeader.response
fhirclient.models.messageheader.MessageHeader.responsible
fhirclient.models.messageheader.MessageHeader.sender
fhirclient.models.messageheader.MessageHeader.source
fhirclient.models.messageheader.MessageHeader.timestamp

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