cardea.fhir.Endpoint

class cardea.fhir.Endpoint(dict_values=None)

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

Parameters

  • resourceType – This is a Endpoint resource

  • identifier – Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

  • status – active | suspended | error | off | test.

  • connectionType – A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

  • name – A friendly name that this endpoint can be referred to with.

  • managingOrganization – The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).

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

  • period – The interval during which the endpoint is expected to be operational.

  • payloadType – The payload type describes the acceptable content that can be communicated on the endpoint.

  • payloadMimeType – The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

  • address – The uri that describes the actual end-point to connect to.

  • header – Additional headers / information to send as part of the notification.

__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.
cardea.fhir.Encounter cardea.fhir.EnrollmentRequest