-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from aleksandr-oleinikov/aidbox-sdc-api-genera…
…te-link Add aidbox-sdc-api.md
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
description: Custom SDC operations supported by Aidbox Forms. | ||
--- | ||
|
||
* [$generate-link](aidbox-sdc-api.md#generate-a-link-to-a-questionnaireresponse-usdgenerate-link) | ||
|
||
# Generate a link to a QuestionnaireResponse - $generate-link | ||
|
||
This operation generates a link to a web page to be used to continue answering a specified [QuestionnaireResponse](https://hl7.org/fhir/R4/questionnaireresponse.html). | ||
|
||
## URLs | ||
|
||
``` | ||
POST [base]/QuestionnaireResponse/[id]/$generate-link | ||
``` | ||
|
||
## Parameters | ||
|
||
### allow-amend | ||
|
||
Whether the generated link will allow amending and re-submitting the form. | ||
|
||
``` | ||
name: allow-amend | ||
value: | ||
Boolean: true | ||
``` | ||
|
||
### redirect-on-submit | ||
|
||
A URL where the user will be redirected to after successfully submitting the form. | ||
|
||
```yaml | ||
name: redirect-on-submit | ||
value: | ||
String: https://example.com/submit-hook?questionnaire=123 | ||
``` |