Module health.clients.fhir
ballerinax/health.clients.fhir Ballerina library
3.0.0
Package containing a generic FHIR client connector that can be used to connect to a FHIR server.
Package overview
This package is used to connect to a FHIR server using the FHIRConnector.
Compatibility
| Version | |
|---|---|
| REST API Specification | https://hl7.org/fhir/http.html |
| Bulk Data Export IG | https://hl7.org/fhir/uv/bulkdata/export.html |
Features and Capabilities
- Connects to a FHIR server that supports any widely used authentication mechanism. Eg: Oauth2, basic auth, etc.
- Support for all the FHIR interactions mentioned in the above specification.
- Support for all the FHIR bulk data export operations.
- Handle authentication to the server.
- Caching and managing the access tokens.
- Support for both FHIR+JSON and FHIR+XML payloads.
- Rewrite FHIR server URL in the response payload and headers with a custom URL.
Functions
extractResourceType
Isolated Function
Extracts the resource type from the given payload.
handleError
Isolated Function
Creates an HTTP response with an operation outcome error.
Parameters
- msg string - Error message to populate the operation outcome
- statusCode int (default http:STATUS_INTERNAL_SERVER_ERROR) - HTTP status code to be set in the response
Return Type
- Response - The HTTP response with the operation outcome error
handleResponse
Isolated Function
function handleResponse(FHIRResponse|FHIRError fhirResponse) returns ResponseCreates an HTTP response from the given FHIRResponse.
Parameters
- fhirResponse FHIRResponse|FHIRError - FHIR response to be converted to HTTP response
Return Type
- Response - The HTTP response
waitForBulkExportCompletion
Isolated Function
function waitForBulkExportCompletion(string exportId)Waits for the completion of a bulk export file download.
This function continuously checks the status of a bulk export task identified by taskId.
It blocks execution until the export task status is "Downloaded", indicating the file download is complete.
Parameters
- exportId string - The unique identifier of the export task to monitor.
Clients
health.clients.fhir: FHIRConnector
Isolated
This connector allows you to connect and interact with any FHIR server
Constructor
Initializes the FHIR client connector
init (FHIRConnectorConfig connectorConfig, boolean enableCapabilityStatementValidation)- connectorConfig FHIRConnectorConfig - FHIR connector configurations
- enableCapabilityStatementValidation boolean true - Whether to validate the capability statement of the server
getById
Isolated FunctionRemote Function
function getById(ResourceType|string 'type, string id, MimeType? returnMimeType, SummaryType? summary) returns FHIRResponse|FHIRErrorRetrieves a FHIR Resource by the resource logical ID
Parameters
- 'type ResourceType|string - The name of the resource type
- id string - The logical id of the resource
- returnMimeType MimeType? (default ()) - The MIME type of the response
- summary SummaryType? (default ()) - The subset of the resource content to be returned
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
getByVersion
Isolated FunctionRemote Function
function getByVersion(ResourceType|string 'type, string id, string 'version, MimeType? returnMimeType, SummaryType? summary) returns FHIRResponse|FHIRErrorRetrieves a version specific FHIR resource
Parameters
- 'type ResourceType|string - The name of the resource type
- id string - The logical id of the resource
- 'version string - the version id
- returnMimeType MimeType? (default ()) - The MIME type of the response
- summary SummaryType? (default ()) - The subset of the resource content to be returned
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
update
Isolated FunctionRemote Function
function update(json|xml data, OnCondition? onCondition, MimeType? returnMimeType, PreferenceType returnPreference) returns FHIRResponse|FHIRErrorUpdates an existing resource or creates a new resource if the resource doesn't exists
Parameters
- data json|xml - Resource data
- onCondition OnCondition? (default ()) - Condition for a conditional update operation.
- To perform a conditional update, you can:
- Provide the conditional URL directly as a string (e.g.,
"identifier=12345&status=active"). - Or, provide conditional parameters as a
SearchParametersormap<string[]>, which will be used to construct the conditional URL. - If not specified, a normal update is performed.
- returnMimeType MimeType? (default ()) - The MIME type of the response
- returnPreference PreferenceType (default MINIMAL) - To specify the content of the return response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
patch
Isolated FunctionRemote Function
function patch(ResourceType|string 'type, json|xml data, string id, OnCondition? onCondition, MimeType? returnMimeType, MimeType|PatchContentType? patchContentType, PreferenceType returnPreference) returns FHIRResponse|FHIRErrorPartially Updates an existing resource
Parameters
- 'type ResourceType|string - The name of the resource type
- data json|xml - Resource data
- id string - The logical id of the resource
- onCondition OnCondition? (default ()) - Condition for a conditional patch operation.
- To perform a conditional patch, you can:
- Provide the conditional URL directly as a string (e.g.,
"identifier=12345&status=active"). - Or, provide conditional parameters as a
SearchParameters, ormap<string[]>, which will be used to construct the conditional URL. - If not specified, a normal patch is performed.
- returnMimeType MimeType? (default ()) - The MIME type of the response
- patchContentType MimeType|PatchContentType? (default ()) - Content type of the patch payload
- returnPreference PreferenceType (default MINIMAL) - To specify the content of the return response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
delete
Isolated FunctionRemote Function
function delete(ResourceType|string 'type, string id, OnCondition? onCondition) returns FHIRResponse|FHIRErrorDeletes an existing resource.
Parameters
- 'type ResourceType|string - The name of the resource type
- id string - The logical id of the resource
- onCondition OnCondition? (default ()) - Condition for a conditional delete operation.
- To perform a conditional delete, you can:
- Provide the conditional URL directly as a string (e.g.,
"identifier=12345&status=active"). - Or, provide conditional parameters as a
SearchParameters, ormap<string[]>, which will be used to construct the conditional URL. - If not specified, a normal delete is performed.
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
getInstanceHistory
Isolated FunctionRemote Function
function getInstanceHistory(ResourceType|string 'type, string id, HistorySearchParameters parameters, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorRetrieves the change history of particular resource
Parameters
- 'type ResourceType|string - The name of the resource type
- id string - The logical id of the resource
- parameters HistorySearchParameters (default {}) - The history search parameters
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
create
Isolated FunctionRemote Function
function create(json|xml data, OnCondition? onCondition, MimeType? returnMimeType, PreferenceType returnPreference) returns FHIRResponse|FHIRErrorCreates a new resource
Parameters
- data json|xml - Resource data
- onCondition OnCondition? (default ()) - Condition for a conditional create operation.
- To perform a conditional create, you can:
- Provide the conditional URL directly as a string (e.g.,
"identifier=12345&status=active"). - Or, provide conditional parameters as a
SearchParameters, ormap<string[]>, which will be used to construct the conditional URL. - If not specified, a normal create is performed.
- returnMimeType MimeType? (default ()) - The MIME type of the response
- returnPreference PreferenceType (default MINIMAL) - To specify the content of the return response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
search
Isolated FunctionRemote Function
function search(ResourceType|string 'type, RequestMode mode, SearchParameters|map<string[]>? searchParameters, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorSearches all resources of a particular type
Parameters
- 'type ResourceType|string - The name of the resource type
- mode RequestMode (default GET) - The request mode, GET or POST
- searchParameters SearchParameters|map<string[]>? (default ()) - The search parameters
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
getHistory
Isolated FunctionRemote Function
function getHistory(ResourceType|string 'type, HistorySearchParameters parameters, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorRetrieves the change history of a particular resource type.
Parameters
- 'type ResourceType|string - The name of the resource type
- parameters HistorySearchParameters (default {}) - The history search parameters
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
getConformance
Isolated FunctionRemote Function
function getConformance(ModeType mode, MimeType? returnMimeType, map<anydata>? uriParameters) returns FHIRResponse|FHIRErrorRetrieves information about the server capabilities
Parameters
- mode ModeType (default FULL) - The information type required from the server
- returnMimeType MimeType? (default ()) - The MIME type of the response
- uriParameters map<anydata>? (default ()) - The additional parameters like _summary, _elements, refer the server capabilities
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
getAllHistory
Isolated FunctionRemote Function
function getAllHistory(HistorySearchParameters parameters, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorRetrieves the change history for all resources supported by the server.
Parameters
- parameters HistorySearchParameters (default {}) - The history search parameters
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
searchAll
Isolated FunctionRemote Function
function searchAll(SearchParameters|map<string[]> searchParameters, RequestMode mode, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorSearches across all resources types
Parameters
- searchParameters SearchParameters|map<string[]> - The search parameters that are common across all resources
- mode RequestMode (default GET) - The request mode, GET or POST
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
batchRequest
Isolated FunctionRemote Function
function batchRequest(json|xml data, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorSubmits a set of actions to perform on a server in a single request, actions will be performed independently as a batch
Parameters
- data json|xml - Resource data
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
'transaction
Isolated FunctionRemote Function
function 'transaction(json|xml data, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorSubmits a set of actions to perform on a server in a single request,actions will be performed as a single atomic transaction
Parameters
- data json|xml - Resource data
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
nextBundle
Isolated FunctionRemote Function
function nextBundle(FHIRResponse|json|xml currentBundle) returns FHIRResponse|FHIRError?Provides support to paginate through resources where applicable(ex: History, Search related bundle resources), retrieves the next bundle if it exists
Parameters
- currentBundle FHIRResponse|json|xml - Current bundle resource should be generated as a result of invoking a connector method. This is to ensure consistency of urlRewrite feature. If the urlRewrite is enabled, the current bundles' urls should be rewritten.
Return Type
- FHIRResponse|FHIRError? - If successful, FhirResponse record else FhirError record
previousBundle
Isolated FunctionRemote Function
function previousBundle(FHIRResponse|json|xml currentBundle) returns FHIRResponse|FHIRError?Provides support to paginate through resources where applicable(ex: History, Search related bundle resources), retrieves the previous bundle if it exists
Parameters
- currentBundle FHIRResponse|json|xml - Current bundle resource should be generated as a result of invoking a connector method. This is to ensure consistency of urlRewrite feature. If the urlRewrite is enabled, the current bundles' urls should be rewritten.
Return Type
- FHIRResponse|FHIRError? - If successful, FhirResponse record else FhirError record
bulkExport
Isolated FunctionRemote Function
function bulkExport(BulkExportLevel bulkExportLevel, string? groupId, BulkExportParameters? bulkExportParameters) returns FHIRResponse|FHIRErrorSubmits a FHIR bulk data export kickoff request
Parameters
- bulkExportLevel BulkExportLevel - Bulk export level
- groupId string? (default ()) - Group ID of the resource group to be exported. Required only if Group export level is selected
- bulkExportParameters BulkExportParameters? (default ()) - Bulk export parameters
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
bulkStatus
Isolated FunctionRemote Function
function bulkStatus(string? contentLocation, string? exportId) returns FHIRResponse|FHIRErrorChecks the status and progress of a bulk data export request using the export task ID.
This function retrieves the export task from in-memory storage using the provided exportId.
If the export task exists, it returns a FHIRResponse containing the export task details as JSON.
If the export task does not exist, it returns a FHIRError with error details.
Parameters
- contentLocation string? (default ()) - The URL to poll for the bulk export status, typically found in the response header of the kickoff request
- If provided, this URL can be used to check the status of the export
- exportId string? (default ()) - The unique identifier for the export task (used as the polling URL or status reference)
- If provided, this ID is used to retrieve the export task from in-memory storage
- If not provided, the function will attempt to use the
contentLocation
Return Type
- FHIRResponse|FHIRError - On success, returns a
FHIRResponserecord with export task details; on failure, returns aFHIRErrorrecord
callOperation
Isolated FunctionRemote Function
function callOperation(ResourceType|string 'type, string operationName, RequestMode mode, string? id, map<string[]>? queryParameters, json|xml? data, MimeType? returnMimeType) returns FHIRResponse|FHIRErrorInvokes a custom FHIR operation (e.g., $lookup, $everything) on a resource type.
This function allows invoking FHIR operations that are not covered by standard CRUD methods, such as $lookup, $everything, or any other custom operation defined by the FHIR server.
Parameters
- 'type ResourceType|string - The name of the resource type on which the operation is invoked
- operationName string - The name of the FHIR operation (e.g., "$lookup", "$everything")
- mode RequestMode (default POST) - The request mode, GET or , default is POST
- id string? (default ()) - The logical id of the resource (optional, used for instance-level operations)
- data json|xml? (default ()) - Resource data to be sent in the request body (for POST operations)
- returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type
- FHIRResponse|FHIRError - If successful, FhirResponse record else FhirError record
Enums
health.clients.fhir: BulkExportLevel
Members
EXPORT_PATIENT
EXPORT_SYSTEM
EXPORT_GROUP
health.clients.fhir: BulkExportOutputType
Members
FHIR_ND_JSON
health.clients.fhir: BundleType
Types of a FHIR bundle
Members
BATCH
TRANSACTION
health.clients.fhir: ExportFileServerType
Members
FHIR
FTP
LOCAL
health.clients.fhir: MimeType
FHIR accepted MIME types
Members
FHIR_JSON
FHIR_XML
health.clients.fhir: ModeType
Specifies the information that should return in the capability statement
Members
FULL
NORMATIVE
TERMINOLOGY
health.clients.fhir: PatchContentType
FHIR accepted PATCH content types
Members
PATCH_JSON
PATCH_XML
health.clients.fhir: PreferenceType
Specifies the content that should return when performing create,update or patch
Members
MINIMAL
REPRESENTATION
OPERATION_OUTCOME
health.clients.fhir: RequestMode
Members
POST
GET
health.clients.fhir: ResourceType
Types of resources
Members
ACCOUNT
ACTIVITY_DEFINITION
ADVERSE_EVENT
ALLERGY_INTOLERANCE
APPOINTMENT
APPOINTMENT_RESPONSE
AUDIT_EVENT
BASIC
BINARY
BIOLOGICALLY_DERIVED_PRODUCT
BODY_STRUCTURE
BUNDLE
CAPABILITY_STATEMENT
CARE_PLAN
CARE_TEAM
CATALOG_ENTRY
CHARGE_ITEM
CHARGE_ITEM_DEFINITION
CLAIM
CLAIM_RESPONSE
CLINICAL_IMPRESSION
CODE_SYSTEM
COMMUNICATION
COMMUNICATION_REQUEST
COMPARTMENT_DEFINITION
COMPOSITION
CONCEPT_MAP
CONDITION
CONSENT
CONTRACT
COVERAGE
COVERAGE_ELIGIBILITY_REQUEST
COVERAGE_ELIGIBILITY_RESPONSE
DETECTED_ISSUE
DEVICE
DEVICE_DEFINITION
DEVICE_METRIC
DEVICE_REQUEST
DEVICE_USE_STATEMENT
DIAGNOSTIC_REPORT
DOCUMENT_MANIFEST
DOCUMENT_REFERENCE
DOMAIN_RESOURCE
EFFECT_EVIDENCE_SYNTHESIS
ENCOUNTER
ENDPOINT
ENROLLMENT_REQUEST
ENROLLMENT_RESPONSE
EPISODE_OF_CARE
EVENT_DEFINITION
EVIDENCE
EVIDENCE_VARIABLE
EXAMPLE_SCENARIO
EXPLANATION_OF_BENEFIT
FAMILY_MEMBER_HISTORY
FLAG
GOAL
GRAPH_DEFINITION
GROUP
GUIDANCE_RESPONSE
HEALTHCARE_SERVICE
IMAGING_STUDY
IMMUNIZATION
IMMUNIZATION_EVALUATION
IMMUNIZATION_RECOMMENDATION
IMPLEMENTATION_GUIDE
INSURANCE_PLAN
INVOICE
LIBRARY
LINKAGE
LIST
LOCATION
MEASURE
MEASURE_REPORT
MEDIA
MEDICATION
MEDICATION_ADMINISTRATION
MEDICATION_DISPENSE
MEDICATION_KNOWLEDGE
MEDICATION_REQUEST
MEDICATION_STATEMENT
MEDICINAL_PRODUCT
MEDICINAL_PRODUCT_AUTHORIZATION
MEDICINAL_PRODUCT_CONTRAINDICATION
MEDICINAL_PRODUCT_INDICATION
MEDICINAL_PRODUCT_INGREDIENT
MEDICINAL_PRODUCT_INTERACTION
MEDICINAL_PRODUCT_MANUFACTURED
MEDICINAL_PRODUCT_PACKAGED
MEDICINAL_PRODUCT_PHARMACEUTICAL
MEDICINAL_PRODUCT_UNDESIRABLE_EFFECT
MESSAGE_DEFINITION
MESSAGE_HEADER
MOLECULAR_SEQUENCE
NAMING_SYSTEM
NUTRITION_ORDER
OBSERVATION
OBSERVATION_DEFINITION
OPERATION_DEFINITION
OPERATION_OUTCOME
ORGANIZATION
ORGANIZATION_AFFILIATION
PARAMETERS
PATIENT
PAYMENT_NOTICE
PAYMENT_RECONCILIATION
PERSON
PLAN_DEFINITION
PRACTITIONER
PRACTITIONER_ROLE
PROCEDURE
PROVENANCE
QUESTIONNAIRE
QUESTIONNAIRE_RESPONSE
RELATED_PERSON
REQUEST_GROUP
RESEARCH_DEFINITION
RESEARCH_ELEMENT_DEFINITION
RESEARCH_STUDY
RESEARCH_SUBJECT
RESOURCE
RISK_ASSESSMENT
SCHEDULE
SEARCH_PARAMETER
SERVICE_REQUEST
SLOT
SPECIMEN
SPECIMEN_DEFINITION
STRUCTURE_DEFINITION
STRUCTURE_MAP
SUBSCRIPTION
SUBSTANCE
SUBSTANCE_NUCLEIC_ACID
SUBSTANCE_POLYMER
SUBSTANCE_PROTEIN
SUBSTANCE_REFERENCE_INFORMATION
SUBSTANCE_SOURCE_MATERIAL
SUBSTANCE_SPECIFICATION
SUPPLY_DELIVERY
SUPPLY_REQUEST
TASK
TERMINOLOGY_CAPABILITIES
TEST_REPORT
TEST_SCRIPT
VALUE_SET
VERIFICATION_RESULT
VISION_PRESCRIPTION
health.clients.fhir: SummaryType
Specifies the subset of the resource to be returned
Members
TRUE
FALSE
TEXT
DATA
COUNT
Records
health.clients.fhir: BaseBulkExportParameters
Closed record
Represents common parameters that can be used in bulk export kick off request
Fields
- _outputFormat string(default FHIR_ND_JSON) - Output encoding style
- _since? string - Time instant where only resources that were last updated on or after the given time will be included in the export
- _type? string[] - Array of resource types to include in the export
- _typeFilter? string[] - Array of search URL that can be used to narrow the scope of the export
health.clients.fhir: BaseSearchParameters
Closed record
Represents the common search parameters across all resources
Fields
- _id? string - Logical id of this artifact
- _lastUpdated? string[] - When the resource version last changed
- _list? string - All resources in nominated list (by id, Type/id, url or one of the magic List types)
- _profile? string - Profiles this resource claims to conform to
- _query? string - A custom search profile that describes a specific defined query operation
- _source? string - Identifies where the resource comes from
- _security? string - Security Labels applied to this resource
- _tag? string - Tags applied to this resource
- _text? string - Search on the narrative text (html) of the resource
- _type? string - Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
- _content? string - Search on the entire content of the resource
- _filter? string - Filter search parameter which supports a more sophisticated grammar for searching
- _has? string - Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to)
health.clients.fhir: BulkExportConfig
Closed record
Configs of the file server where bulk export files will be stored
Fields
- fileServerType ExportFileServerType(default LOCAL) - fhir, ftp, or local
- fhir: Sync the exported files with a FHIR server
- ftp: Send the exported files to a FTP server
- local: Save the exported files in the local file system
- fileServerUrl string(default "") - Bulk export file server base url
- fileServerPort int(default 21) - Port to access the file server, default is 21
- fileServerUsername string(default "") - Username to access the server, for ftp
- fileServerPassword string(default "") - Password to access the server, for ftp
- fileServerDirectory string(default "") - Directory to save the exported files in the file server, for ftp
- pollingInterval decimal(default DEFAULT_POLLING_INTERVAL) - Bulk status polling interval in seconds, default is 2 seconds
- tempDirectory string(default DEFAULT_EXPORT_DIRECTORY) - Local directory to save the exported files, for local file server
- tempFileExpiryTime decimal(default DEFAULT_TEMP_FILE_EXPIRY) - Expiration period for temporary export files in seconds, for local file server
health.clients.fhir: BulkExportParameters
Represents parameters that can be used in bulk export kick off request, add more name value pairs if necessary
Fields
- Fields Included from *BaseBulkExportParameters
health.clients.fhir: ExportedFileUrlInfo
Closed record
Represents the exported file URLs and related metadata for a bulk export operation.
Fields
- exportId string - The unique identifier for the export operation
- expiryTime? string - The expiration time for the exported files (as a string, e.g., UTC timestamp or "N/A")
- output OutputFile[] - An array of OutputFile records, each containing details about an exported file
health.clients.fhir: FHIRConnectorConfig
Closed record
Represents FHIR client connector configurations
Fields
- baseURL string - FHIR server base URL
- mimeType MimeType(default FHIR_JSON) - global MIME type of the return response, can be configured at method level as well
- authConfig? (ClientAuthConfig|PKJWTAuthConfig) - Authentication configs that will be used to create the http client
- urlRewrite boolean(default false) - Whether to rewrite FHIR server URL, can be configured at method level as well
- replacementURL? string - Base url of the service to rewrite FHIR server URLs
- bulkExportConfig? BulkExportConfig - Bulk export file server configs
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- proxy ProxyConfig?(default ()) - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionalty which provided by the constraint package. Enabled by default
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- secureSocket ClientSecureSocket?(default ()) - Provides settings related to SSL/TLS
health.clients.fhir: FHIRConnectorErrorDetail
Closed record
Represent Connector related errors
Fields
- errorDetails? error - the full error
health.clients.fhir: FHIRResponse
Closed record
Represents a success response coming from the fhir server side
Fields
- httpStatusCode int - HTTP status code from the interaction
- 'resource json|xml - Field Description
health.clients.fhir: FHIRServerErrorDetails
Closed record
Represents the details of the error response that represents an unsuccessful interaction with the server
Fields
- httpStatusCode int - HTTP status code from the interaction
- 'resource json|xml - Field Description
health.clients.fhir: HistorySearchParameters
Represents parameters that can be used in a history interaction, add more name value pairs if necessary
Fields
- _count string(default "10") - The maximum number of search results on a single response
- _since? string - Only include resource versions that were created at or after the given instant in time
- _at? string - Only include resource versions that were current at some point during the specified time period
- _list? string - Only include resource versions that are referenced in the specified list
health.clients.fhir: OutputFile
Represents metadata for an exported FHIR resource file.
Fields
- 'type string -
- url string - The URL or path where the exported file can be accessed
health.clients.fhir: SearchParameters
Represents parameters that can be used in a search interaction, add more name value pairs if necessary
Fields
- Fields Included from *BaseSearchParameters
Errors
health.clients.fhir: FHIRConnectorError
Distinct
Represents the error type for connector side errors
health.clients.fhir: FHIRError
Represents the errors that can be returned from the connector
health.clients.fhir: FHIRServerError
Distinct
Represents the error type for an unsuccessful interaction with the server
Union types
health.clients.fhir: OnCondition
OnCondition
Represents the possible types that can be used as a condition in conditional FHIR interactions.
Used in conditional create, update, or delete operations. Can be one of:
SearchParameters: A set of search parameters to match resources.map<string[]>: A map of key-value pairs (with array values) representing search conditions.string: The conditional URL directly as a string (e.g.,"identifier=12345").
For a conditional create, update or delete, you can:
- Provide the conditional URL directly as a string for the
onConditionparameter. - Or, provide conditional parameters as a
SearchParametersormap<string[]>to construct the conditional URL.