Package dev.dsf.bpe.v2.service

Interface EndpointProvider

public interface EndpointProvider
Provides access to Endpoint resources from the DSF FHIR server.

  • Method Details

    • getLocalEndpointAddress

      String getLocalEndpointAddress()
      Returns:
      Local DSF FHIR server base URL, e.g. https://foo.bar/fhir

    • getLocalEndpoint

      Optional<org.hl7.fhir.r4.model.Endpoint> getLocalEndpoint()
      Returns:
      Endpoint resource from the local DSF FHIR server associated with the configured base URL, empty Optional if no such resource exists
      See Also:

    • getLocalEndpointIdentifier

      default Optional<org.hl7.fhir.r4.model.Identifier> getLocalEndpointIdentifier()
      Returns:
      DSF identifier of the Endpoint resource from the local DSF FHIR server associated with the configured base URL, empty Optional if no such resource exists or the Endpoint does not have a DSF identifier
      See Also:

    • getLocalEndpointIdentifierValue

      default Optional<String> getLocalEndpointIdentifierValue()
      Returns:
      DSF identifier value of the Endpoint resource from the local DSF FHIR server associated with the configured base URL, empty Optional if no such resource exists or the Endpoint does not have a DSF identifier
      See Also:

    • getEndpoint

      Optional<org.hl7.fhir.r4.model.Endpoint> getEndpoint(org.hl7.fhir.r4.model.Identifier endpointIdentifier)
      Parameters:
      endpointIdentifier - may be null
      Returns:
      Active Endpoint resource from the local DSF FHIR server with the given endpointIdentifier, empty Optional if no such resource exists or the given identifier is null
      See Also:

    • getEndpoint

      default Optional<org.hl7.fhir.r4.model.Endpoint> getEndpoint(String endpointIdentifierValue)
      Parameters:
      endpointIdentifierValue - may be null
      Returns:
      Active Endpoint resource from the local DSF FHIR server with the given DSF endpointIdentifierValue, empty Optional if no such resource exists or the given identifier value is null
      See Also:

    • getEndpointAddress

      default Optional<String> getEndpointAddress(org.hl7.fhir.r4.model.Identifier endpointIdentifier)
      Parameters:
      endpointIdentifier - may be null
      Returns:
      Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given endpointIdentifier, empty Optional if no such resource exists or the given identifier is null
      See Also:

    • getEndpointAddress

      default Optional<String> getEndpointAddress(String endpointIdentifierValue)
      Parameters:
      endpointIdentifierValue - may be null
      Returns:
      Address (base URL) of the active Endpoint resource from the local DSF FHIR server with the given DSF endpointIdentifierValue, empty Optional if no such resource exists or the given identifier value is null
      See Also:

    • getEndpoint

      Optional<org.hl7.fhir.r4.model.Endpoint> getEndpoint(org.hl7.fhir.r4.model.Identifier parentOrganizationIdentifier, org.hl7.fhir.r4.model.Identifier memberOrganizationIdentifier, org.hl7.fhir.r4.model.Coding memberOrganizationRole)
      Parameters:
      parentOrganizationIdentifier - may be null
      memberOrganizationIdentifier - may be null
      memberOrganizationRole - may be null
      Returns:
      Active Endpoint resource from the local DSF FHIR server associated with the given memberOrganizationIdentifier and memberOrganizationRole in a parent organization with the given parentOrganizationIdentifier, empty Optional if no such resource exists or one of the parameters is null; only considers Endpoints from active OrganizationAffiliation resources
      See Also:

    • getEndpoint

      default Optional<org.hl7.fhir.r4.model.Endpoint> getEndpoint(String parentOrganizationIdentifierValue, String memberOrganizationIdentifierValue, String memberOrganizationRoleCode)
      Parameters:
      parentOrganizationIdentifierValue - may be null
      memberOrganizationIdentifierValue - may be null
      memberOrganizationRoleCode - may be null
      Returns:
      Active Endpoint resource from the local DSF FHIR server associated with the given DSF memberOrganizationIdentifierValue and memberOrganizationRoleCode in a parent organization with the given DSF parentOrganizationIdentifierValue, empty Optional if no such resource exists or one of the parameters is null; only considers Endpoints from active OrganizationAffiliation resources
      See Also:

    • getEndpointAddress

      default Optional<String> getEndpointAddress(org.hl7.fhir.r4.model.Identifier parentOrganizationIdentifier, org.hl7.fhir.r4.model.Identifier memberOrganizationIdentifier, org.hl7.fhir.r4.model.Coding memberOrganizationRole)
      Parameters:
      parentOrganizationIdentifier - may be null
      memberOrganizationIdentifier - may be null
      memberOrganizationRole - may be null
      Returns:
      Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with the given memberOrganizationIdentifier and memberOrganizationRole in a parent organization with the given parentOrganizationIdentifier, empty Optional if no such resource exists or one of the parameters is null; only considers Endpoints from active OrganizationAffiliation resources
      See Also:

    • getEndpointAddress

      default Optional<String> getEndpointAddress(String parentOrganizationIdentifierValue, String memberOrganizationIdentifierValue, String memberOrganizationRoleCode)
      Parameters:
      parentOrganizationIdentifierValue - may be null
      memberOrganizationIdentifierValue - may be null
      memberOrganizationRoleCode - may be null
      Returns:
      Address (base URL) of the active Endpoint resource from the local DSF FHIR server associated with the given DSF memberOrganizationIdentifierValue and memberOrganizationRoleCode in a parent organization with the given DSF parentOrganizationIdentifierValue, empty Optional if no such resource exists or one of the parameters is null; only considers Endpoints from active OrganizationAffiliation resources
      See Also:

    • getEndpoints

      List<org.hl7.fhir.r4.model.Endpoint> getEndpoints(org.hl7.fhir.r4.model.Identifier parentOrganizationIdentifier, org.hl7.fhir.r4.model.Coding memberOrganizationRole)
      Parameters:
      parentOrganizationIdentifier - may be null
      memberOrganizationRole - may be null
      Returns:
      Active Endpoint resources from the local DSF FHIR server associated with the given memberOrganizationRole in a parent organization with the given parentOrganizationIdentifier, empty List if no resources exist or one of the parameters is null; only considers Endpoints from active OrganizationAffiliation resources
      See Also:

    • getEndpoints

      default List<org.hl7.fhir.r4.model.Endpoint> getEndpoints(String parentOrganizationIdentifierValue, String memberOrganizationRoleCode)
      Parameters:
      parentOrganizationIdentifierValue - may be null
      memberOrganizationRoleCode - may be null
      Returns:
      Active Endpoint resources from the local DSF FHIR server associated with the given memberOrganizationRoleCode in a parent organization with the given DSF parentOrganizationIdentifierValue, empty List if no resources exist or one of the parameters is null; only considers Endpoints from active OrganizationAffiliation resources
      See Also: