-
Notifications
You must be signed in to change notification settings - Fork 1
Dsf 2 doc improvements #122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
74654d7
updated gitignore
schwzr 76ee9b6
updated javadoc
schwzr 793a5cb
updated FHIR IG
schwzr 413d53e
added minimal version of api-gen scripts
schwzr f3da2f8
use local fhir ig instead of gitlab hosted fhir ig
schwzr 0c0caf9
updated role config docs
schwzr 07a5c4e
added first draft of logging documentation
schwzr ac8fc5f
updated trusted certificate page to reflect DSF 2 changes
schwzr 788ae2a
updated system requirements
schwzr 76ac60c
improved upgrade instructions, added postgres update manual
schwzr 4967df3
updated menu
schwzr edddbde
Update install-plugins.md
MadMax93 ddc9455
Update install-plugins.md
MadMax93 751393f
Update install-plugins.md
MadMax93 6ae2ac7
Update install-plugins.md
MadMax93 1bcaf30
Update install-plugins.md
MadMax93 6e55cc9
renamed 2.0.0-RC2 to 2.0.0
schwzr edace74
set 2.0.0 to latest version, adopted menu
schwzr 9c093de
fixed review comments
schwzr fddb3f9
fixed broken link
schwzr d78fc35
Merge remote-tracking branch 'origin/main' into dsf-2-doc-improvements
schwzr d341514
tar.gz files for 2.0.0, updated row numbers in install.md
hhund File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,15 +5,15 @@ icon: config | |
|
|
||
| ## Overview | ||
|
|
||
| The DSF FHIR server implements a subset of the FHIR R4 [REST API](http://hl7.org/fhir/R4/http.html). When accessing the API with a web browser a limited graphical user interface is shown. Without any additional configuration the API and user interface is only accessible with the X.509 client certificate configured for the organization via the configuration parameter: [DEV_DSF_FHIR_SERVER_ORGANIZATION_THUMBPRINT](configuration#dev-dsf-fhir-server-organization-thumbprint) | ||
| The DSF FHIR server implements a subset of the FHIR R4 [REST API](http://hl7.org/fhir/R4/http.html). When accessing the API with a web browser a limited graphical user interface is shown. Without any additional configuration the API and user interface is only accessible with the X.509 client certificate configured for the organization via the client certificate configuration parameter [DEV_DSF_FHIR_CLIENT_CERTIFICATE](configuration##dev-dsf-fhir-client-certificate) or the manual override option [DEV_DSF_FHIR_SERVER_ORGANIZATION_THUMBPRINT](configuration#dev-dsf-fhir-server-organization-thumbprint). | ||
|
|
||
| ::: tip OpenID Connect | ||
| To enable OpenID Connect authentication of local user, see the DSF FHIR server OpenID Connect [configuration page](oidc). | ||
| ::: | ||
|
|
||
| Access to the API and user interface can be enabled for additional client certificates and local users authenticating via OAuth 2.0 OpenID Connect. Access can be configured for so called roles, with all roles specified using the configuration parameter [DEV_DSF_FHIR_SERVER_ROLECONFIG](configuration#dev-dsf-fhir-server-roleconfig). The value for this environment variable is specified as YAML using the block scalar `|`. | ||
|
|
||
| The listing below shows a minimal configuration to enable read access for a specific client-certificate: | ||
| The listing below shows a minimal configuration to enable read access for all resources for a specific client-certificate: | ||
|
|
||
| ```yaml | ||
| DEV_DSF_FHIR_SERVER_ROLECONFIG: | | ||
|
|
@@ -24,7 +24,20 @@ The listing below shows a minimal configuration to enable read access for a spec | |
| - SEARCH | ||
| - HISTORY | ||
| ``` | ||
| The list of user roles above contains a single rule-entry `example_read_only_role`, matching the user via a client certificate SHA-512 thumbprint and assigning three DSF roles. Any string can be used as the name for the rule-enty. | ||
|
|
||
| The list of user roles above contains a single rule-entry `example_read_only_role`, matching the user via a client certificate SHA-512 thumbprint and assigning three DSF roles. Any string can be used as the name for the rule-entry. | ||
|
|
||
| With DSF 2, you can now restrict the granted priviledges to specific resource types. If you want to restrict the rule-entry `example_read_only_role` to Organization resources, you can specify the resource type per dsf-role ("action"): | ||
|
|
||
| ```yaml | ||
| DEV_DSF_FHIR_SERVER_ROLECONFIG: | | ||
| - example_read_only_organization_role: | ||
| thumbprint: 00474993fa261b0225f93c5a66aa6fcc... [a-f0-9]{128} | ||
| dsf-role: | ||
| - READ: [Organization] | ||
| - SEARCH: [Organization] | ||
| - HISTORY: [Organization] | ||
| ``` | ||
|
|
||
| ::: tip Certificate Thumbprints | ||
| SHA-512 certificate thumbprints in HEX form `[a-f0-9]{128}` can be calculated using: | ||
|
|
@@ -62,14 +75,15 @@ DSF roles specified via the `dsf-role` property define general access to the RES | |
|
|
||
| `CREATE`, `READ`, `UPDATE`, `DELETE`, `SEARCH`, `HISTORY`, `PERMANENT_DELETE` and `WEBSOCKET`. | ||
|
|
||
|
|
||
| #### practitioner-role | ||
|
|
||
| In order to allow users to start processes, the property `practitioner-role` can be used to assign codes from FHIR [CodeSystem](http://hl7.org/fhir/R4/codesystem.html) resources. Codes are specified in the form `system-url|code`. | ||
| If the uses has a code specified here that match with a `requester` extension within the process plugin's [ActivityDefinition](http://hl7.org/fhir/R4/activitydefinition.html) resource, the user can start the process if he also has the `dsf-role` `CREATE`. | ||
|
|
||
| Process plugins can defined and use there own code-systems. However, the DSF specifies a standard set of practitioner roles within the CodeSystem `http://dsf.dev/fhir/CodeSystem/practitioner-role`: | ||
|
|
||
| `UAC_USER`, `COS_USER`, `CRR_USER`, `DIC_USER`, `DMS_USER`, `DTS_USER`, `HRP_USER`, `TTP_USER`, `AMS_USER` and `DSF_ADMIN`. | ||
| `UAC_USER`, `COS_USER`, `CRR_USER`, `DIC_USER`, `DMS_USER`, `DTS_USER`, `HRP_USER`, `TTP_USER`, `AMS_USER`, `ASP_USER`, `SPR_USER`, `TSP_USER`, `PPH_USER`, `BIO_USER`, and `DSF_ADMIN`. | ||
|
|
||
|
|
||
| ## Examples | ||
|
|
@@ -114,7 +128,7 @@ The second example defines a group of DSF administrators by specifying an `admin | |
| ``` | ||
|
|
||
|
|
||
| The third example allows read-only access. Two e-mail addresses are used to match this role. E-mail addresses from X.509 client certificates and OAuth 2.0 access tokens are matched: | ||
| The third example allows read-only access, restricted to QuestionnaireResponse resources only. Two e-mail addresses are used to match this role. E-mail addresses from X.509 client certificates and OAuth 2.0 access tokens are matched: | ||
|
|
||
| ```yaml | ||
| DEV_DSF_FHIR_SERVER_ROLECONFIG: | | ||
|
|
@@ -123,7 +137,8 @@ The third example allows read-only access. Two e-mail addresses are used to matc | |
| - [email protected] | ||
| - [email protected] | ||
| dsf-role: | ||
| - READ | ||
| - SEARCH | ||
| - HISTORY | ||
| - READ: [QuestionnaireResponse] | ||
| - UPDATE: [QuestionnaireResponse] | ||
| - SEARCH: [QuestionnaireResponse] | ||
| - HISTORY: [QuestionnaireResponse] | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.