r4

r4

Model and related classes like bindings for FHIR® Release 4 (R4).

Since:
  • 1.0.0
Source:

Classes

Context
FHIRContextBinding
FHIRListBinding
FHIRModel
FHIRPropertyBinding
FHIRTreeBinding

Members

(static) OperationMode :string

Different modes for executing service operations (filtering, sorting)

Properties:
Name Type Description
Server string

Operations are executed on the server in the FHIR service request, by appending corresponding URL parameters for filter and sorting. Each change in filtering or sorting triggers a new request to the server.

Client string

not supported

Operations are executed on the client. This only works if all entries are loaded on the client. The initial request fetches the complete collection, filtering and sorting does not trigger further requests.

Version:
  • 2.4.0
Since:
  • 1.0.0
Author:
  • SAP SE
Source:
Type:
  • string

(static) SubmitMode :string

Modes to control the use of bundle requests for a group ID.

Properties:
Name Type Description
Batch string

Requests associated with the group ID are sent in a bundle with bundle type 'batch' request via sap.fhir.model.r4.FHIRModel#submitBundle.

Transaction string

Requests associated with the group ID are sent in a bundle with bundle type 'transaction' request via sap.fhir.model.r4.FHIRModel#submitBundle.

Direct string

Requests associated with the group ID are sent directly without bundle.

Version:
  • 2.4.0
Since:
  • 1.0.0
Author:
  • SAP SE
Source:
Type:
  • string

Type Definitions

Properties:
Name Type Description
url string

The url to which the request should fired

mParameters sap.fhir.model.r4.FHIRListBinding.Parameter | sap.fhir.model.r4.FHIRTreeBinding.Parameter

The parameters that will be passed as query strings

Since:
  • 2.3.2
Source:
Type:
  • object

RequestParameters

Properties:
Name Type Attributes Description
urlParameters object <optional>

The parameters that will be passed as query strings

successBeforeMapping function <optional>

The callback function which is executed if the request was successful, in particular before the map process starts

success function <optional>

The callback function which is executed if the request was successful, in particular after the map process has been finished

error function <optional>

The callback function which is executed if the request failed

headers object <optional>

Additional HTTP Headers which should be added to the request

groupId string <optional>

Identifier for the creation of a bundle which contains several requests

Since:
  • 1.0.0
Source:
Type:
  • object