cardea.fhir.Subscription

class cardea.fhir.Subscription(dict_values=None)

The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined “channel” so that another system is able to take an appropriate action.

Parameters
  • resourceType – This is a Subscription resource

  • status – The status of the subscription, which marks the server state for managing the subscription.

  • contact – Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

  • end – The time for the server to turn the subscription off.

  • reason – A description of why this subscription is defined.

  • criteria – The rules that the server should use to determine when to generate notifications for this subscription.

  • error – A record of the last error that occurred when the server processed a notification.

  • channel – Details where to send notifications when resources are received that meet the criteria.

  • tag – A tag to add to any resource that matches the criteria, after the subscription is processed.

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