HS.BulkFHIR.Fetch.PureFHIR.Config

class HS.BulkFHIR.Fetch.PureFHIR.Config extends HS.BulkFHIR.API.Data.AdapterConfig

Property Inventory

client_name
endpoint_url
fetch_count
fetch_token_credential_id
fetch_token_scopes
grant_type
http_credential_id
http_timeout
max_req_per_sec
oauth_issuer_url
resource_types
ssl_configuration
worker_jobs
x_api_key_credential_id

Method Inventory

%OnValidateObject()

Parameters

parameter SETTINGS = endpoint_url:::Endpoint URL,ssl_configuration:::SSL Configuration,resource_types,max_req_per_sec:::Max Requests Per Second,http_timeout:::HTTP Timeout,http_credential_id:HTTP:Authorization:HTTP Credential ID,x_api_key_credential_id:X-API:Authorization:X-API Key Credential,oauth_issuer_url:OAuth:Authorization:OAuth Issuer URL,client_name:OAuth:Authorization,grant_type:OAuth:Authorization,fetch_token_scopes:OAuth:Authorization,fetch_token_credential_id:OAuth:Authorization:Fetch Token Credential ID,worker_jobs;

https://usjira.iscinternal.com/browse/IF-3640 style like {property}:{group}:{category}:{property rename} where group, category, and property rename are optional. In this case category would be Authorization, and groups would be HTTP, X-API, OAuth. A '-' before a setting will exclude it from the list returned to the UI

Properties

property client_name as %String);

Name to identify the Bulk FHIR Coordinator with the FHIR endpoint's OAuth server, if using OAuth.

Property methods: client_nameDisplayToLogical(), client_nameGet(), client_nameIsValid(), client_nameLogicalToDisplay(), client_nameLogicalToOdbc(), client_nameNormalize(), client_nameSet()

property endpoint_url as %String (MAXLEN = 250) [ Required ];

Base full url for a FHIR resource server endpoint, eg. "https://example.org/fhir/r4"

Property methods: endpoint_urlDisplayToLogical(), endpoint_urlGet(), endpoint_urlIsValid(), endpoint_urlLogicalToDisplay(), endpoint_urlLogicalToOdbc(), endpoint_urlNormalize(), endpoint_urlSet()

property fetch_count as %Integer [ InitialExpression = 500 ];

_count to add to search and $everything requests Setting this value over the default for the FHIR Server can speed up performance by reducing paging. Note, FHIR Servers may have a limit lower than the selected value for how many results will be returned per page and some FHIR Servers may not support _count for all request types

Property methods: fetch_countDisplayToLogical(), fetch_countGet(), fetch_countIsValid(), fetch_countLogicalToDisplay(), fetch_countNormalize(), fetch_countSet(), fetch_countXSDToLogical()

property fetch_token_credential_id as %String;

The Interoperability Credential ID to use in authenticating with the FHIR endpoint's OAuth server for a grant type that needs Basic Auth credentials.

Property methods: fetch_token_credential_idDisplayToLogical(), fetch_token_credential_idGet(), fetch_token_credential_idIsValid(), fetch_token_credential_idLogicalToDisplay(), fetch_token_credential_idLogicalToOdbc(), fetch_token_credential_idNormalize(), fetch_token_credential_idSet()

property fetch_token_scopes as list of %String);

Comma-delimited list of OAuth scopes to specify when obtaining an access token from the FHIR endpoint's OAuth server. Applies only when there was no access token in the request to the Bulk FHIR Coordinator.

Property methods: fetch_token_scopesBuildValueArray(), fetch_token_scopesCollectionToDisplay(), fetch_token_scopesCollectionToOdbc(), fetch_token_scopesDisplayToCollection(), fetch_token_scopesDisplayToLogical(), fetch_token_scopesGet(), fetch_token_scopesGetObject(), fetch_token_scopesGetObjectId(), fetch_token_scopesGetSwizzled(), fetch_token_scopesIsValid(), fetch_token_scopesLogicalToDisplay(), fetch_token_scopesLogicalToOdbc(), fetch_token_scopesNormalize(), fetch_token_scopesOdbcToCollection(), fetch_token_scopesSet(), fetch_token_scopesSetObject(), fetch_token_scopesSetObjectId()

property grant_type as %String (VALUELIST = ",client_credentials,password");

OAuth grant type to use when obtaining an access token from the FHIR endpoint's OAuth server.

Property methods: grant_typeDisplayToLogical(), grant_typeGet(), grant_typeIsValid(), grant_typeLogicalToDisplay(), grant_typeLogicalToOdbc(), grant_typeNormalize(), grant_typeSet()

property http_credential_id as %String;

The Interoperability Credential ID to use in authenticating with the FHIR endpoint if using Basic Auth.

Property methods: http_credential_idDisplayToLogical(), http_credential_idGet(), http_credential_idIsValid(), http_credential_idLogicalToDisplay(), http_credential_idLogicalToOdbc(), http_credential_idNormalize(), http_credential_idSet()

property http_timeout as %Integer [ InitialExpression = 180 ];

Timeout value when fetching data from resource server.

Property methods: http_timeoutDisplayToLogical(), http_timeoutGet(), http_timeoutIsValid(), http_timeoutLogicalToDisplay(), http_timeoutNormalize(), http_timeoutSet(), http_timeoutXSDToLogical()

property max_req_per_sec as %Integer [ InitialExpression = 10 , Required ];

Maximum number of HTTP requests to make to the FHIR endpoint in a second. This number will be shared across all active export operations, and may be used to limit the load imposed by the coordinator on the endpoint.

Property methods: max_req_per_secDisplayToLogical(), max_req_per_secGet(), max_req_per_secIsValid(), max_req_per_secLogicalToDisplay(), max_req_per_secNormalize(), max_req_per_secSet(), max_req_per_secXSDToLogical()

property oauth_issuer_url as %String);

Issuer url for the FHIR endpoint's OAuth server.

Property methods: oauth_issuer_urlDisplayToLogical(), oauth_issuer_urlGet(), oauth_issuer_urlIsValid(), oauth_issuer_urlLogicalToDisplay(), oauth_issuer_urlLogicalToOdbc(), oauth_issuer_urlNormalize(), oauth_issuer_urlSet()

property resource_types as list of %String;

Default list of resource types to include in an export operation. Can be overridden by a client using the _type query parameter. Leaving this empty will include all resource types by default.

Property methods: resource_typesBuildValueArray(), resource_typesCollectionToDisplay(), resource_typesCollectionToOdbc(), resource_typesDisplayToCollection(), resource_typesDisplayToLogical(), resource_typesGet(), resource_typesGetObject(), resource_typesGetObjectId(), resource_typesGetSwizzled(), resource_typesIsValid(), resource_typesLogicalToDisplay(), resource_typesLogicalToOdbc(), resource_typesNormalize(), resource_typesOdbcToCollection(), resource_typesSet(), resource_typesSetObject(), resource_typesSetObjectId()

property ssl_configuration as %String [ InitialExpression = $$$BFCBaseSSLConfig ];

Default SSL configuration when using https

Property methods: ssl_configurationDisplayToLogical(), ssl_configurationGet(), ssl_configurationIsValid(), ssl_configurationLogicalToDisplay(), ssl_configurationLogicalToOdbc(), ssl_configurationNormalize(), ssl_configurationSet()

property worker_jobs as %Integer [ InitialExpression = 4 ];

Number of worker jobs (background) assigned to do processing

Property methods: worker_jobsDisplayToLogical(), worker_jobsGet(), worker_jobsIsValid(), worker_jobsLogicalToDisplay(), worker_jobsNormalize(), worker_jobsSet(), worker_jobsXSDToLogical()

property x_api_key_credential_id as %String;

The Interoperability Credential ID to use in authenticating with the FHIR endpoint if using the x-api-key header. The credential password shall contain the api key.

Property methods: x_api_key_credential_idDisplayToLogical(), x_api_key_credential_idGet(), x_api_key_credential_idIsValid(), x_api_key_credential_idLogicalToDisplay(), x_api_key_credential_idLogicalToOdbc(), x_api_key_credential_idNormalize(), x_api_key_credential_idSet()

Methods

method %OnValidateObject() as %Status

Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

Subclasses

HS.BulkFHIR.Fetch.ODS.Config