HS.BulkFHIR.Fetch.Util.RestClient

Maximum number of retries for obtaining an OAuth token during $export when obtain fails.

@API
Use an IRIS OAuth API call to verify that a token exists and is active for the specified OAuth client name and SessionId. If not found or not active, then obtain a new token.

@Input pOAuthClientName OAuth client name.
@Input pTokenSessionId OAuth token 'SessionId" value to use for storing and retrieving an access token. This is not the same item as the BFC sessionId.
@Input pFetchTokenInfo %DynamicObject of information about the access token on the request to the BFC.
@Input pGrantType OAuth token grant type to use when requesting the token.
@Input pEndpointURL Resource server endpoint URL to use in the aud claim.
@Input pHTTPCredentialsConfig Interoperability credentials config ID to use for password grant. @Input pPermitSystemScope whether to permit system scopes @Input pAdditionalAudienceUrl a comma-separated string for any additional audiences

@API
Sends an HTTP GET request to the endpoint configured for this REST client.
@Input path path to send an HTTP request to, eg. "Patient" or "metadata"

Return the OAuth client id for a given OAuth client name.

@API
Return a new unique SessionId to use for OAuth token request, retrieve and revoke.

Derive the OAuth scopes string to use for the access token for resource server interactions. The return value is a space-delimited string of scopes. @Input pPermitSystemScope if falsey (default) all system scopes will be converted to user scopes

@API
Obtain an access token for interactions with the resource server. If successful, the token is stored in a structure from which it can be retrieved, given the OAuth client name and a session id.

@Input pOAuthClientName OAuth client name.
@Input pTokenSessionId OAuth token 'SessionId" value to use for storing and retrieving an access token. This is not the same item as the BFC sessionId.
@Input pFetchTokenInfo %DynamicObject of information about the access token on the request to the BFC.
@Input pGrantType OAuth token grant type to use when requesting the token.
@Input pEndpointURL Resource server endpoint URL to use in the aud claim.
@Input pHTTPCredentialsConfig Interoperability credentials config ID to use for password grant. @Input pPermitSystemScope Whether to permit system scopes @Input pAdditionalAudienceUrl a comma-separated string for any additional audiences

Override HS.FHIRServer.RestClient.HTTP to use the full path provided if pRequestPath is a full URL instead of using the service base URL InvokeRequest takes the Private %HttpRequest object - passed in as pRequest here - and invokes the request. The HTTP response is stored as the HttpResponse property of the HTTP request object. This method returns a reference to that property.
@Input pRequest %Net.HttpRequest object.
@Input pRequestMethod HTTP verb.
@Input pRequestPath Request path, as derived by the invoked interaction-specific method.
@Input pQueryString Query string, as derived by the invoked interaction-specific method.

Internal override to allow for custom headers to be added to outbound requests. This is done because the FHIRServer RestClient class doesn't support custom headers in IRIS 2021.1, which is the minimum target version for BFC.

Revoke an access token that might be in use by this RestClient instance.
Input:
@Input pOAuthClientName OAuth client name.
@Input pTokenSessionId OAuth token 'SessionId" value to use for revoking the access token. This is not the same item as the BFC sessionId.

@API
Returns a configured instance of this class, which can be used as a rest client for fetching content out of the configured FHIR endpoint.
@Input pServiceEntryName Entry in the Service Registry that points to a FHIR endpoint
@Input pMaxRequestsPerSecond Imposes rate limiting on requests using this client object
@Input pTokenObj Object that holds information about the new token to request.
@Input pSessionId BFC sessionId.
@Input pHeaders Custom HTTP headers to add to requests.
@Input pAdditionalAudienceUrl a comma-separated string for any additional audiences