HS.BulkFHIR.API.Data.FetchAdapterConfig
class HS.BulkFHIR.API.Data.FetchAdapterConfig extends HS.BulkFHIR.API.Data.AdapterConfig
base class for all fetch adapter configs they all need to have the client_auth properties, endpoint_url etc.Property Inventory
Method Inventory
Properties
property client_auth_adapter as %String (MAXLEN = 220) [ Required ];
Name of the client auth adapter (unrelated to BulkFHIR.Auth adapters - those are for BFC-as-server validation of requests)
client_auth_adapter is the class that will enable the fetch adapter to authenticate with the Bulk exporting server e.g. Epic
Property methods: client_auth_adapterDisplayToLogical(), client_auth_adapterGet(), client_auth_adapterIsValid(), client_auth_adapterLogicalToDisplay(), client_auth_adapterLogicalToOdbc(), client_auth_adapterNormalize(), client_auth_adapterSet()
property client_auth_config as HS.BulkFHIR.ClientAuth.ConfigBase (%JSONINCLUDE = "OUTPUTONLY") [ Required ];
Accompanying configuration object for the client auth adapter.
Property methods: client_auth_configGet(), client_auth_configGetSwizzled(), client_auth_configIsValid(), client_auth_configNewObject(), client_auth_configSet()
property endpoint_url as %String (MAXLEN = 250) [ Required ];
url of the fhir server serving the $export operations.
Eg. "https://domain/app/FHIR/r4"
Property methods: endpoint_urlDisplayToLogical(), endpoint_urlGet(), endpoint_urlIsValid(), endpoint_urlLogicalToDisplay(), endpoint_urlLogicalToOdbc(), endpoint_urlNormalize(), endpoint_urlSet()
property group_export as %Boolean [ InitialExpression = 1 , Required ];
Whether the Group export operation (/Group//$export)
is supported
Property methods: group_exportDisplayToLogical(), group_exportGet(), group_exportIsValid(), group_exportLogicalToDisplay(), group_exportNormalize(), group_exportSet()
property patient_export as %Boolean [ InitialExpression = 1 , Required ];
Whether the Patient export operation (/Patient/$export)
is supported
Property methods: patient_exportDisplayToLogical(), patient_exportGet(), patient_exportIsValid(), patient_exportLogicalToDisplay(), patient_exportNormalize(), patient_exportSet()
property system_export as %Boolean [ InitialExpression = 1 , Required ];
Whether the system level export operation (/$export)
is supported
Property methods: system_exportDisplayToLogical(), system_exportGet(), system_exportIsValid(), system_exportLogicalToDisplay(), system_exportNormalize(), system_exportSet()
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.
classmethod FromJson(json) as HS.BulkFHIR.API.Data.AdapterConfig
@API
Converts a json string or %DynamicObject into an instance of
the config object
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %JSONExport()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONNew()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()