Communication with external systems using FHIR is performed through endpoint connections. This connection information must be configured in OnBase to send requests to and receive responses from the external system.
Each endpoint defines a set of rules that control how the external system interacts with the OnBase FHIR server. You can configure multiple endpoints to establish multiple sets of rules for different solutions.
An endpoint configuration item consists of references to the following FHIR resources:
FHIR Resource |
Description |
---|---|
Binary |
The content (or bytes) of a document. |
DocumentReference |
The metadata used to reference and describe a document. |
Additionally, each FHIR resource supports one or more of the following operations that can be performed on that resource:
Operation |
Resource Supported |
Description |
---|---|---|
Create (POST) |
DocumentReference |
Archives a document in OnBase. This operation can be configured to apply the External Clinical Document Lock to the document once it is archived to ensure that only the external system can modify the document. |
Delete (DELETE) |
DocumentReference |
Purges a document stored in OnBase. This operation purges the document's binary data, DocumentReference metadata, and other OnBase document data. |
Read (GET) |
Binary, DocumentReference |
Retrieves document data stored in OnBase. This operation can retrieve either binary data or DocumentReference metadata. |
Update (PUT) |
DocumentReference |
Updates document data stored in OnBase. This operation is used to update the document's binary data by making a request on the DocumentReference endpoint resource. Note:
Document metadata (Keyword Values and Document Types) are not updated using the FHIR module, but can be updated using HL7 messages. For more information, see the HL7 module reference guide. |
You can disable and enable endpoint components at the endpoint, resource, and operation levels. For security purposes, you should only enable the endpoints, resources, operations required for your solution. Any unused components should be disabled.
You must also assign mapping templates to the operations used in your solution so that each operation can reference the correct relationships between OnBase Keyword Types and external metadata types.
Additionally, user account authentication is configured at the endpoint level. You must assign an OnBase Service Account to an endpoint.
For detailed procedures on configuring endpoints, see the following sections: