cardea.fhir.MessageHeader

class cardea.fhir.MessageHeader(dict_values=None)

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.

Parameters
  • resourceType – This is a MessageHeader resource

  • event – Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value “http://hl7.org/fhir/message-events”.

  • destination – The destination application which the message is intended for.

  • receiver – Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn’t sufficient.

  • sender – Identifies the sending system to allow the use of a trust relationship.

  • timestamp – The time that the message was sent.

  • enterer – The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.

  • author – The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.

  • source – The source application from which this message originated.

  • responsible – The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.

  • reason – Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

  • response – Information about the message that this message is a response to. Only present if this message is a response.

  • focus – The actual data of the message - a reference to the root/focus class of the event.

__init__(dict_values=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([dict_values])

Initialize self.

assert_type()

Checks class values follow set possible enumerations.

get_dataframe()

Returns dataframe from class attribute values.

get_eligible_relationships()

Returns class relationships for attributes that are used.

get_id()

Returns fhir class identifier.

get_relationships()

Returns class relationships.

set_attributes(dict_values)

Sets values to class attributes.