Configuring Endpoint Settings - FHIR - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Premier - Standard

FHIR

Platform
OnBase
Product
FHIR
Release
Foundation 23.1
License
Premier
Standard

Configuring endpoint settings allows you to disable or enable an endpoint and to define the URL extension for an endpoint.

An endpoint exposes the FHIR resources in OnBase to external systems via an endpoint URL path. This endpoint URL contains a configured endpoint extension, and the external system can only access resources through this extension.

For example, the following sample command from a request message would create and archive a new document, using the extension named sample in the endpoint URL path:

POST http://localhost/appserver/private/fhir/sample/DocumentReference

If your solution includes multiple endpoints, each endpoint has its own URL path constructed with its unique endpoint extension.

To configure endpoint settings:

  1. In the Configuration module, select Medical | FHIR | Endpoints. The FHIR Endpoints dialog box is displayed.
  2. Do one of the following:
    • To create a new endpoint, enter a name for the new endpoint in the field below the list and click Create.

    • To modify an existing endpoint, select it and click Settings.

    The [Endpoint Name] Settings dialog box is displayed.

  3. Confirm or modify the endpoint name in the Display Name field. This value must be unique.
  4. Enter an extension for the endpoint in the Endpoint Extension field. This value must be unique.
    Note:

    Modifying the Endpoint Extension value for an existing endpoint can break functionality if an external system uses an absolute URL to access the endpoint. If you change the Endpoint Extension value, you must also update the external system to reference the new endpoint extension in the URL.

  5. Select an option for the Availability setting to disable or enable the endpoint.
  6. Click Save.

    Once an endpoint is created, you must configure the resources and security settings for the endpoint. Continue to the following sections: