Overview
Configuration is provided for establishing connections with a FHIR server. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to a FHIR sever using COZYROC's REST Connection Manager.
Step 3. Press Test Connection button. When you see Test Connection succeeded, click OK.
Congratulations! You have successfully created a connection to a FHIR server using COZYROC's REST Connection Manager.
In this guide, we will show you how to read data from a FHIR server using the COZYROC REST Source component.
Bravo! You have now learned how to read data from a FHIR server.
In this guide, we will show how to write data to a FHIR server resource using the COZYROC REST Destination component.
Done. You have now learned how to write data into a FHIR server resource.
Configuration
Base URL address: https://[server]
.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The authentication has the following user-defined parameters:
- Auth URL: Required. Specify the authorization endpoint.
- Access Token URL: Required. Specify the authentication endpoint.
- Client Id: Required. Specify client secret.
- Client Secret: Required. Specify client secret.
- Scope: Required. Specify a space-delimited list of the permissions.
- aud: Required for Firely Auth.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.fire.ly/projects/Firely-Server/en/5.2.0/security/firely-auth/firely-auth.html.
- None
-
The authentication uses a parameters-based authentication.
The following request parameters will be automatically processed during the authentication process:
- [Read] action
-
Endpoint URL address:
/{{=resource.name}}
.
The result is extracted from:{{=_.pluck(response.entry, 'resource')}}
.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
Endpoint URL address:
/
.
The result is extracted from:{{=_.pluck(response.entry, 'resource')}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
application/fhir+json:
{{={ resourceType: 'Bundle', type: 'transaction', entry: _.map(batch, function(item) { var url = '/' + resource.name; return { request: { method: 'POST', url: url }, resource: _.extend({ resourceType: resource.name }, item) }; }) } }}
-
_includeUserParameters:
{{=parameters}}
-
application/fhir+json:
- [Update] action
-
Endpoint URL address:
/
.
The result is extracted from:{{=_.pluck(response.entry, 'resource')}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
application/fhir+json:
{{={ resourceType: 'Bundle', type: 'transaction', entry: _.map(batch, function(item) { var url = '/' + resource.name + '/' + item.id; return { request: { method: 'PUT', url: url }, resource: _.extend({ resourceType: resource.name }, item), fullUrl: _.rtrim(connection.serverHost, '/') + url }; }) } }}
-
_includeUserParameters:
{{=parameters}}
-
application/fhir+json:
- [Delete] action
-
Endpoint URL address:
/
.
The result is extracted from:{{=_.pluck(response.entry, 'resource')}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
application/fhir+json:
{{={ resourceType: 'Bundle', type: 'transaction', entry: _.map(batch, function(item) { var url = '/' + resource.name + '/' + item.id; return { request: { method: 'DELETE', url: url }, fullUrl: _.rtrim(connection.serverHost, '/') + url }; }) } }}
-
_includeUserParameters:
{{=parameters}}
-
application/fhir+json:
- [External]
-
The external fields list is extracted from:
{{=FHIR.getFields(resource, parameters)}}
.
The external resource list is extracted from: {{=FHIR.getResources()}}
.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Double
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- BigInt
Data type: DT_I8
- Integer
Data type: DT_I4
- Money
Data type: DT_CY
- DateTime
Data type: DT_DBTIMESTAMP
- Uniqueidentifier
Data type: DT_GUID
- Decimal
Data type: DT_DECIMAL
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.