HS.BulkFHIR.API.Data.Config

Name of the auth adapter to use for authenticating and authorizing clients to interact with the Bulk FHIR coordinator

Configuration object for the auth adapter. The schema for this object will be defined by the auth adapter itself.

Non-administrative users who are permitted to initiate exports on this configuration.

If selected, export jobs will start as soon as the export is requested. If deselected, jobs will require manual approval.

Capability statement of resource server

FHIR package id for this Coordinator. Eg. "hl7.fhir.r4.core@4.0.1"

Relative URL to serve Bulk Export operations from, e.g., "/bulkfhir/r4"

Name of the fetch adapter to use in retreiving clinical data as FHIR.

Configuration object for the fetch adapter. The schema for this object will be defined by the fetch adapter itself.

Name for this Bulk FHIR Coordinator. Will be used as the value in the Coordinator's CapabilityStatement name.

Name of the storage adapter to use for persisting files generated during the bulk export operation.

Configuration object for the storage adapter. The schema for this object will be defined by the storage adapter itself.

denote the version from which this config was created, to support json imports across major code changes

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.

@API Converts a json string or %DynamicObject into an instance of the config object

Inherited description: Optional custom settings for the GUI, i.e. how the end user will interact with the config class and its properties Each property setting may be customized according to the following schema: { name: string (must match precisely name of property in the class) ignore: boolean (if true, no other property need be set - this property will be ignored by GUI and inaccessible to user) display_name: string (name of the field shown to user) Defaults to prettified version of snake case property name description: string (description of the field shown to the user in a hint) Defaults to the property's in-line comment in code is_advanced: boolean (whether the field should be nested in a collapsible "advanced setting" group) If true and the property is required, the property SHOULD have a default, or else results in a poor UX input_type: string (the type of field shown to user) with following value list: "input", "select", "radio", "binary-checkbox", "number". If "select" or "radio", then options must be provided either via literal property VALUELIST or the "presetOptions" GUI setting (see below). If binary-checkbox, the property must be typed %Boolean. Defaults according to the property type as follow: If %Integer or %Double, then "number" If %Boolean, then "binary-checkbox" If VALUELIST is provided, then "select" If the type is a different config class, then special "nested-setting", and the GUI setting for this property will be defined in the "nested_setting" property (see below). Else, "input" preset_options: string (preset list of options available) with following value list (enforced by parameter ValidPresetOptions) "credentials", list of credentials configured in the BFC namespace "client_auth_oauth_clients", list of non-resource OAuth clients as available in the instance. If this preset option is chosen, the UI will show a selectable table of OAuth clients. "oauth_clients", list of all OAuth clients as available in the instance. If this preset option is chosen, the UI will show a selectable table of OAuth clients. "auth_adapters", list of auth adapters available in the BFC namespace "fetch_adapters", list of fetch adapters available in the BFC namespace "client_auth_adapters", list of client auth adapters available in the BFC namespace "storage_adapters", list of storage adapters available in the BFC namespace "tls_configurations", list of TLS configurations "local_fhir_endpoints", list of FHIR Server endpoints local to the instance "fhir_resources", list of applicable FHIR resource types - only applicable if sister property "endpoint_url" exists (as is in HS.BulkFHIR.API.Data.FetchAdapterConfig or subclass, since it relies on discovering what resources the FHIR server supports) default: any (defaults to InitialExpression or %onNew override) required: boolean (whether the property is required, defaults to whether the property is marked as required or not in the class definition) /// The following properties are calculated based on the property and not customizable collection: boolean (calculated from whether the element is a list) nested_setting: array of nested instances of this schema (applies when the property type is a nested config class and thus inputType is "nested-setting") type: string (property data type) options: { name: string, value: string } (derived from VALUELIST/DISPLAYLIST literal properties, not evaluated if preset_options is defined) max_length: number (derived from MAXLEN literal property) }