Difference between revisions of "Server Configuration"

From Hiasobi - FHIR
Jump to: navigation, search
(→‎Detecting FHIR Service Location)
(→‎Embedded Use: Configure FHIR Service)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
−
= Configure FHIR Service =
+
= Embedded Use: Configure FHIR Service =
−
Hiasobi server configuration support two main uses
+
Embedded server configuration supports two main uses:
 +
 
 
1) define how you would like the server to run
 
1) define how you would like the server to run
−
** Embedded - passed in as '''Oridashi.Fhir.Configuration''' object in '''Start''' call on '''Oridashi.Fhir.Host.FhirHost''' server
+
* Embedded - passed in as '''Oridashi.Fhir.Configuration''' object in '''Start''' call on '''Oridashi.Fhir.Host.FhirHost''' server
 
2) define how the server is actually running
 
2) define how the server is actually running
−
** Embedded - returned as actual configuration from '''Start''' call on '''Oridashi.Fhir.Host.FhirHost''' server; find allocated ports
+
* Embedded - returned as actual configuration from '''Start''' call on '''Oridashi.Fhir.Host.FhirHost''' server; find allocated ports
 +
 
  
 
<table border=1 cellspacing=0 cellpadding=5>
 
<table border=1 cellspacing=0 cellpadding=5>
Line 12: Line 14:
 
<tr><td>NetworkServer</td><td>false</td><td>Allows network calls from other machines to this server, default is to only allow the local machine</td></tr>
 
<tr><td>NetworkServer</td><td>false</td><td>Allows network calls from other machines to this server, default is to only allow the local machine</td></tr>
 
<tr><td>AcceptedCrossOrigins</td><td>(null)</td><td>Domains (string array) specifically allowed Cross Origin Resource Sharing domains for browser based calls; default (null) is any domain '*'</td></tr>
 
<tr><td>AcceptedCrossOrigins</td><td>(null)</td><td>Domains (string array) specifically allowed Cross Origin Resource Sharing domains for browser based calls; default (null) is any domain '*'</td></tr>
−
<tr><td>BestPracticePort (DSTU2)</td><td>8290</td><td>Web server port for local Best Practice CIS</td></tr>
+
<tr><td>BestPracticePort</td><td>8290</td><td>Web server port for local Best Practice CIS</td></tr>
−
<tr><td>MedicalDirectorPort (DSTU2)</td><td>8291</td><td>Web server port for local Medical Director CIS</td></tr>
+
<tr><td>MedicalDirectorPort</td><td>8291</td><td>Web server port for local Medical Director CIS</td></tr>
−
<tr><td>ZedmedPort (DSTU2)</td><td>8292</td><td>Web server port for local Zedmed CIS</td></tr>
+
<tr><td>ZedmedPort</td><td>8292</td><td>Web server port for local Zedmed CIS</td></tr>
−
<tr><td>GeniePort (DSTU2)</td><td>8291</td><td>Web server port for local Genie for Windows CIS</td></tr>
+
<tr><td>GeniePort</td><td>8291</td><td>Web server port for local Genie for Windows CIS</td></tr>
−
<tr><td>MedtechPort (DSTU2)</td><td>8291</td><td>Web server port for local Medtech CIS</td></tr>
+
<tr><td>MedtechPort</td><td>8291</td><td>Web server port for local Medtech CIS</td></tr>
 
<tr><td>LicenseKey</td><td>(null)</td><td>Allocated license key for associated ProfileName; required for access to 'live' CIS data</td></tr>
 
<tr><td>LicenseKey</td><td>(null)</td><td>Allocated license key for associated ProfileName; required for access to 'live' CIS data</td></tr>
 
<tr><td>IsLive</td><td>false</td><td>Access to 'live' CIS data, default is samples only</td></tr>
 
<tr><td>IsLive</td><td>false</td><td>Access to 'live' CIS data, default is samples only</td></tr>
 
<tr><td>IsOpen</td><td>false</td><td>Run as an 'open' server over HTTP otherwise is 'closed' run over 'HTTPS' and require authentication</td></tr>
 
<tr><td>IsOpen</td><td>false</td><td>Run as an 'open' server over HTTP otherwise is 'closed' run over 'HTTPS' and require authentication</td></tr>
 
<tr><td>Deidentify</td><td>false</td><td>Remove names and human identifiers for patients and providers </td></tr>
 
<tr><td>Deidentify</td><td>false</td><td>Remove names and human identifiers for patients and providers </td></tr>
 +
<tr><td>SSLThumbprint</td><td>null</td><td></td></tr>
 +
<tr><td>SSLPassword</td><td>null</td><td></td></tr>
 +
<tr><td>IncludeAgent</td><td>false</td><td></td></tr>
 +
<tr><td>RESTWriteMode</td><td>Create</td><td></td></tr>
 +
<tr><td>OridashiVersion</td><td>-</td><td>Registry/Read Only - current version of Oridashi-Hiasobi running</td></tr>
 +
<tr><td>BPApplicationRoleName</td><td>-</td><td>BP Partner Application Role Name</td></tr>
 +
<tr><td>BPApplicationRolePassword</td><td>-</td><td>BP Partner Application Role Password</td></tr>
 
</table>
 
</table>
  
  
−
 
+
.
−
= Detecting FHIR Service Location =
+
−
Embedded and Standalone - registry entries made under the current user key
+
−
 
+
−
1) Check registry for last known service details
+
−
 
+
−
<pre> HKEY_CURRENT_USER\Software\Oridashi\Hiasobi\<profile name></pre>
+
−
 
+
−
Profile name is your company/product id allocated by Oridashi.
+
−
 
+
−
'''config''': JSON string with configuration data as per below
+
−
* '''iss''': issuer is FHIR server endpoint e.g. https://localhost.oridashi.com.au:8249
+
−
* '''running''' : is running status if started and stopped normally
+
−
* '''pid''': process identifier of host application/service
+
−
 
+
−
2) Check service is running
+
−
* if '''running''' == false then FHIR service is NOT running (if true need to check further)
+
−
* if '''pid''' is not running for the current user then the FHIR service is NOT running (if found then check further)
+
−
* '''iss''' is URL for FHIR service a should respond to <pre>GET <url>/Metadata</pre> (no credentials required)
+
−
If passed then the FHIR service is available on the '''iss'' URL,
+
−
Credentials are required to gain access i.e. allocated profile basic credentials or SMART on FHIR bearer token.
+

Latest revision as of 14:48, 17 June 2019

Embedded Use: Configure FHIR Service

Embedded server configuration supports two main uses:

1) define how you would like the server to run

  • Embedded - passed in as Oridashi.Fhir.Configuration object in Start call on Oridashi.Fhir.Host.FhirHost server

2) define how the server is actually running

  • Embedded - returned as actual configuration from Start call on Oridashi.Fhir.Host.FhirHost server; find allocated ports


PropertyDefaultDescription
ProfileName'default'Identifying name (is allocated for licensed users)
NetworkServerfalseAllows network calls from other machines to this server, default is to only allow the local machine
AcceptedCrossOrigins(null)Domains (string array) specifically allowed Cross Origin Resource Sharing domains for browser based calls; default (null) is any domain '*'
BestPracticePort8290Web server port for local Best Practice CIS
MedicalDirectorPort8291Web server port for local Medical Director CIS
ZedmedPort8292Web server port for local Zedmed CIS
GeniePort8291Web server port for local Genie for Windows CIS
MedtechPort8291Web server port for local Medtech CIS
LicenseKey(null)Allocated license key for associated ProfileName; required for access to 'live' CIS data
IsLivefalseAccess to 'live' CIS data, default is samples only
IsOpenfalseRun as an 'open' server over HTTP otherwise is 'closed' run over 'HTTPS' and require authentication
DeidentifyfalseRemove names and human identifiers for patients and providers
SSLThumbprintnull
SSLPasswordnull
IncludeAgentfalse
RESTWriteModeCreate
OridashiVersion-Registry/Read Only - current version of Oridashi-Hiasobi running
BPApplicationRoleName-BP Partner Application Role Name
BPApplicationRolePassword-BP Partner Application Role Password


.

Retrieved from "http://www.fhir.oridashi.com.au/wiki/index.php?title=Server_Configuration&oldid=779"