Module

fhir_client_connector

Module fhir_client_connector

API

extractResourceTypeNId
validateBundleData

FhirConnector

Declarations

BundleType
MimeType
ModeType
PatchContentType
PreferenceType
ResourceType
SummaryType

Definitions

BaseSearchParameters
FhirConnectorConfig
FhirConnectorErrorDetail
FhirResponse
FhirServerErrorDetails
HistorySearchParameters
ResourceTypeNId
SearchParameters

FhirConnectorError
FhirError
FhirServerError

thishanidev/fhir_client_connector

0.1.0

Functions

extractResourceTypeNId

Isolated Function
function extractResourceTypeNId(json|xml data, boolean extractId) returns ResourceTypeNId|error
Parameters
  • data json|xml - 
  • extractId boolean (default true) - 

validateBundleData

Isolated Function
function validateBundleData(json|xml data, BundleType bundleType) returns boolean|error
Parameters
  • data json|xml - 

Clients

fhir_client_connector: FhirConnector

Isolated

This connector allows you to connect and interact with any FHIR server

Constructor

Initializes the FHIR client connector

init (FhirConnectorConfig connectorConfig, *ClientConfiguration httpClientConfig)

getById

Isolated FunctionRemote Function
function getById(ResourceType|string 'type, string id, MimeType? returnMimeType, SummaryType? summary) returns FhirResponse|FhirError

Retrieves a FHIR Resource by the resource logical ID

Parameters
  • 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

getByVersion

Isolated FunctionRemote Function
function getByVersion(ResourceType|string 'type, string id, string 'version, MimeType? returnMimeType, SummaryType? summary) returns FhirResponse|FhirError

Retrieves a version specific FHIR resource

Parameters
  • 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

update

Isolated FunctionRemote Function
function update(json|xml data, MimeType? returnMimeType, PreferenceType returnPreference) returns FhirResponse|FhirError

Updates an existing resource or creates a new resource if the resource doesn't exists

Parameters
  • data json|xml - Resource data
  • returnMimeType MimeType? (default ()) - The MIME type of the response
  • returnPreference PreferenceType (default MINIMAL) - To specify the content of the return response
Return Type

patch

Isolated FunctionRemote Function
function patch(ResourceType|string 'type, string id, json|xml data, MimeType? returnMimeType, MimeType|PatchContentType? patchContentType, PreferenceType returnPreference) returns FhirResponse|FhirError

Partially Updates an existing resource

Parameters
  • id string - The logical id of the resource
  • data json|xml - Resource data
  • returnMimeType MimeType? (default ()) - The MIME type of the response
  • returnPreference PreferenceType (default MINIMAL) - To specify the content of the return response
Return Type

delete

Isolated FunctionRemote Function
function delete(ResourceType|string 'type, string id) returns FhirResponse|FhirError

Deletes an existing resource

Parameters
  • id string - The logical id of the resource
Return Type

getInstanceHistory

Isolated FunctionRemote Function
function getInstanceHistory(ResourceType|string 'type, string id, HistorySearchParameters parameters, MimeType? returnMimeType) returns FhirResponse|FhirError

Retrieves the change history of particular resource

Parameters
  • id string - The logical id of the resource
  • returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type

create

Isolated FunctionRemote Function
function create(json|xml data, MimeType? returnMimeType, PreferenceType returnPreference) returns FhirResponse|FhirError

Creates a new resource

Parameters
  • data json|xml - Resource data
  • returnMimeType MimeType? (default ()) - The MIME type of the response
  • returnPreference PreferenceType (default MINIMAL) - To specify the content of the return response
Return Type
Isolated FunctionRemote Function
function search(ResourceType|string 'type, SearchParameters|map<string[]>? searchParameters, MimeType? returnMimeType) returns FhirResponse|FhirError

Searches all resources of a particular type

Parameters
  • returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type

getHistory

Isolated FunctionRemote Function
function getHistory(ResourceType|string 'type, HistorySearchParameters parameters, MimeType? returnMimeType) returns FhirResponse|FhirError

Retrieves the change history of a particular resource type.

Parameters
  • returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type

getConformance

Isolated FunctionRemote Function
function getConformance(ModeType mode, MimeType? returnMimeType, map<anydata>? uriParameters) returns FhirResponse|FhirError

Retrieves 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

getAllHistory

Isolated FunctionRemote Function
function getAllHistory(HistorySearchParameters parameters, MimeType? returnMimeType) returns FhirResponse|FhirError

Retrieves the change history for all resources supported by the server.

Parameters
  • returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type

searchAll

Isolated FunctionRemote Function
function searchAll(SearchParameters|map<string[]> searchParameters, MimeType? returnMimeType) returns FhirResponse|FhirError

Searches across all resources types

Parameters
  • returnMimeType MimeType? (default ()) - The MIME type of the response
Return Type

batchRequest

Isolated FunctionRemote Function
function batchRequest(json|xml data, MimeType? returnMimeType) returns FhirResponse|FhirError

Submits 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

'transaction

Isolated FunctionRemote Function
function 'transaction(json|xml data, MimeType? returnMimeType) returns FhirResponse|FhirError

Submits 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

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
Return Type

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
Return Type

Enums

fhir_client_connector: BundleType

Members

BATCH
TRANSACTION

fhir_client_connector: MimeType

FHIR accepted MIME types

Members

FHIR_JSON
FHIR_XML

fhir_client_connector: ModeType

Specifies the information that should return in the capability statement

Members

FULL
NORMATIVE
TERMINOLOGY

fhir_client_connector: PatchContentType

FHIR accepted PATCH content types

Members

PATCH_JSON
PATCH_XML

fhir_client_connector: PreferenceType

Specifies the content that should return when performing create,update or patch

Members

MINIMAL
REPRESENTATION
OPERATION_OUTCOME

fhir_client_connector: ResourceType

Types of resources

Members

PATIENT
PRACTITIONER

fhir_client_connector: SummaryType

Specifies the subset of the resource to be returned

Members

TRUE
FALSE
TEXT
DATA
COUNT

Records

fhir_client_connector: 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)

fhir_client_connector: 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

fhir_client_connector: FhirConnectorErrorDetail

Closed record

Represent Connector related errors

Fields
  • errorDetails error? - the full error

fhir_client_connector: 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
  • serverResponseHeaders map<string> - Map of header values returning from the server

fhir_client_connector: 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
  • serverResponseHeaders map<string> - Map of header values returning from the server

fhir_client_connector: 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

fhir_client_connector: ResourceTypeNId

Closed record
Fields

fhir_client_connector: SearchParameters

Represents parameters that can be used in a search interaction, add more name value pairs if necessary

Fields

Errors

fhir_client_connector: FhirConnectorError

Distinct
FhirConnectorErrorDetail

Represents the error type for connector side errors

fhir_client_connector: FhirError

FhirServerError|FhirConnectorError

Represents the errors that can be returned from the connector, of two types FhirServerError and FhirConnectorError

fhir_client_connector: FhirServerError

Distinct
FhirServerErrorDetails

Represents the error type for an unsuccessful interaction with the server

Import

import thishanidev/fhir_client_connector;Copy

Other versions

0.1.1

0.1.0

Metadata

Released date: almost 3 years ago

Version: 0.1.0

Compatibility

Platform: any

Ballerina version: 2201.2.0

GraalVM compatible: Yes

Pull count

Total: 8

Current verison: 7

Weekly downloads

Dependencies

ballerina/regex/1.3.0ballerina/http/2.4.0ballerina/log/2.4.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC