Service Endpoint

The services of SAP Health Data Services for FHIR use a unified service endpoint provided in the generated service key.

The service endpoint is the base URL for accessing all FHIR resources of SAP Health Data Services for FHIR. The service key contains all the information you need to build or retrieve this URL.

Your use case determines which service key property to use:

Use Case

Supported Services

Recommendation

Property

UI-based applications (for example, SAPUI5)

Core, conformance, authorization, messaging

Use the preconfigured service endpoint.

hdsf_url_for_app

Back-end integrations

Core, conformance, authorization, messaging

Build the service endpoint manually or use the preconfigured service endpoint.

hdsf_url or hdsf_url_for_app

Content lifecycle management with FHIR packages

Registry, provisioning

Build the service endpoint manually.

hdsf_url

Prerequisites

You have generated the service key for your service instance of SAP Health Data Services for FHIR.

Building the Service Endpoint

If you need to build the service endpoint yourself, use the hdsf_url property. Add the namespace value and the fhir path segment:

<hdsf_url>/<namespace>/fhir

Parameters

  • hdsf_url - Protocol and hostname of SAP Health Data Services for FHIR.

  • namespace - Custom namespace for the service instance of SAP Health Data Services for FHIR that ensures all instances created have unique names.

  • /fhir - Fixed path for accessing FHIR resources.

Preconfigured Service Endpoint

For UI clients that cannot build URLs dynamically, use the hdsf_url_for_app property. This property contains the fully constructed base URL that you can use without additional configuration.

Example

The following example shows the relevant properties in a generated service key.

The region parameter indicates where SAP Health Data Services for FHIR is configured. The generated service key includes this parameter by default.