cardea.fhir.Communication

class cardea.fhir.Communication(dict_values=None)

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.

Parameters
  • resourceType – This is a Communication resource

  • identifier – Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

  • definition – A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.

  • basedOn – An order, proposal or plan fulfilled in whole or in part by this Communication.

  • partOf – Part of this action.

  • status – The status of the transmission.

  • notDone – If true, indicates that the described communication event did not actually occur.

  • notDoneReason – Describes why the communication event did not occur in coded and/or textual form.

  • category – The type of message conveyed such as alert, notification, reminder, instruction, etc.

  • medium – A channel that was used for this communication (e.g. email, fax).

  • subject – The patient or group that was the focus of this communication.

  • recipient – The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).

  • topic – The resources which were responsible for or related to producing this communication.

  • context – The encounter within which the communication was sent.

  • sent – The time when this communication was sent.

  • received – The time when this communication arrived at the destination.

  • sender – The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

  • reasonCode – The reason or justification for the communication.

  • reasonReference – Indicates another resource whose existence justifies this communication.

  • payload – Text, attachment(s), or resource(s) that was communicated to the recipient.

  • note – Additional notes or commentary about the communication by the sender, receiver or other interested parties.

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