helix_fhir_client_sdk.graph.graph_definition

Module Contents

Classes

GraphDefinitionTarget

Create a target for a link

GraphDefinitionLink

Create a link to another resource

GraphDefinition

Creates a GraphDefinition object to use in a $graph call
class helix_fhir_client_sdk.graph.graph_definition.GraphDefinitionTarget(*, type_, params=None, link=None)

Create a target for a link :param type_: Type of child resource :param params: Used for a reverse link where the child resource has a property that is a reference

back to the parent

Parameters

  • link (Optional[List[GraphDefinitionLink]]) – Nested for additional links to children of this child resource

  • type_ (str) –

  • params (Optional[str]) –

to_dict(self)
Return type

Dict[str, Any]

Create a link to another resource

Parameters

  • path (Optional[str]) – Optional path for forward links i.e., the parent resource has a property that is a reference to this related resource

  • target (List[GraphDefinitionTarget]) – list of targeted resources.

to_dict(self)

Returns this object as a dictionary

Return type

Dict[str, Any]

class helix_fhir_client_sdk.graph.graph_definition.GraphDefinition(*, id_, name, start, link)

Creates a GraphDefinition object to use in a $graph call

Parameters

  • id – id for this GraphDefinition resource

  • start (str) – Fhir Resource to start from

  • link (List[GraphDefinitionLink]) – list of links

  • id_ (str) –

  • name (str) –

to_dict(self)

Returns this object as a dictionary

Return type

Dict[str, Any]