Skip to content

Commit 42980d5

Browse files
committed
Replace domain with example.org because we neither own the domain tutorial.org nor is it unresolvable
1 parent 8588393 commit 42980d5

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/src/process-development/api-v2/dsf/organization-identifiers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ icon: creative
44
---
55

66
## Organization Identifiers
7-
DSF FHIR server instances can configure an `organization identifier`. It uniquely identifies the organization the DSF FHIR server instance belongs to for its [Allow-List mechanism](https://dsf.dev/intro/info/allowList.html). It is set as an [environment variable](https://dsf.dev/stable/maintain/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). A GET request to `https://domain/fhir/Organization` will return a list of all organizations for the DSF FHIR server instance running under `domain`. The results will also include the `organization identifier` of each organization.
7+
DSF FHIR server instances can configure an `organization identifier`. It uniquely identifies the organization the DSF FHIR server instance belongs to for its [Allow-List mechanism](https://dsf.dev/intro/info/allowList.html). It is set as an [environment variable](https://dsf.dev/stable/maintain/fhir/configuration.html#dev-dsf-fhir-server-organization-identifier-value). A GET request to `https://example.org/fhir/Organization` will return a list of all organizations for the DSF FHIR server instance running under `example.org`. The results will also include the `organization identifier` of each organization.
88

99
### Organization Identifiers in Task Resources
1010
[Task](../fhir/task.md) resources require a reference to an organization via its identifier as the `Task.requester` and `Task.restriction.recipient` elements. The exact values for these elements depend on the [ActivityDefinition](../fhir/activitydefinition.md) the [Task](../fhir/task.md) resource should conform to. As a general rule, the identifier of your own organization should be used as the `Task.requester` and `Task.restriction.recipient` elements for [Task](../fhir/task.md) resources which initially start processes. All other cases depend on the context of the message being sent during process execution. An easy way to generalize this in [Draft Task Resources](draft-task-resources.md) is to use the `#{organization}` [placeholder](versions-placeholders-urls.md#placeholders).

docs/src/process-development/api-v2/dsf/versions-placeholders-urls.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ To avoid specifying the version and release date in multiple files, the placehol
2222

2323
BPMN models have an ID called process definition key. The BPMN process definition key needs to be specified following the pattern:
2424
```
25-
^[-a-zA-Z0-9]+_[-a-zA-Z0-9]+$ Example: domainorg_processKey
25+
^[-a-zA-Z0-9]+_[-a-zA-Z0-9]+$ Example: exampleorg_processKey
2626
```
2727
In addition, the BPMN model needs to specify a version. The `#{version}` [placeholder](#placeholders) should be used for this as well. The DSF will also reference this process in URL form in FHIR resources:
2828
```
29-
http://domain.org/bpe/Process/processKey|1.2
29+
http://example.org/bpe/Process/processKey|1.2
3030
```
3131

3232
The version in the URL `|1.2` only uses the resource version and omits the code base version. As mentioned in [Version Pattern](#version-pattern), this means that only changes to the first two version numbers are significant to signal compatibility when communicating with other process plugin instances. The process definition key and URL are also related to each other. The DSF will try to match BPMN models to FHIR resources by transforming the URL into a process definition key. That is why it is mandatory to follow the pattern above.
3333

3434
The above URL will be used as the instantiatesCanonical value for [Task](../fhir/task.md) profile definitions as well as references to [Task](../fhir/task.md) profiles in other resources. It is also used as the URL value for [ActivityDefinitions](../fhir/activitydefinition.md). In this case though, the URL has to be split into two parts. The version (`|1.2`) needs to be separated from the URL and used as a value for the `ActivityDefinition.version` element. Since it refers to the plugin's resource version, the `#{version}` [placeholder](#placeholders) should be used here instead. Going by the example from above, the final URL looks like this:
3535
```
36-
http://domain.org/bpe/Process/processKey
36+
http://example.org/bpe/Process/processKey
3737
```
3838
This will be the value for the `ActivityDefinition.url` element with `#{version}` as the value for the `ActivityDefinition.version` element.
3939

0 commit comments

Comments
 (0)