cardea.fhir.CommunicationRequest

class cardea.fhir.CommunicationRequest(dict_values=None)

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Parameters
  • resourceType – This is a CommunicationRequest resource

  • identifier – A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.

  • basedOn – A plan or proposal that is fulfilled in whole or in part by this request.

  • replaces – Completed or terminated request(s) whose function is taken by this new request.

  • groupIdentifier – A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

  • status – The status of the proposal or order.

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

  • priority – Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

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

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

  • recipient – The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

  • topic – The resources which were related to producing this communication request.

  • context – The encounter or episode of care within which the communication request was created.

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

  • occurrenceDateTime – The time when this communication is to occur.

  • occurrencePeriod – The time when this communication is to occur.

  • authoredOn – For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

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

  • requester – The individual who initiated the request and has responsibility for its activation.

  • reasonCode – Describes why the request is being made in coded or textual form.

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

  • note – Comments made about the request by the requester, sender, recipient, subject or other participants.

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