Skip to content

Document the PlanDefinition route required for form packages #5

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.

Sign up for GitHub

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

Open
alex-serednev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the PlanDefinition route required for form packages #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/aidbox-ui-builder-alpha/smart-app-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,28 @@ matcho:
- '#^/QuestionnaireResponse/[^/]+/\$[a-z-]+$'
- '#^/fhir/Questionnaire(/[^/]+)?(/\$[a-z-]+)?/?$'
- '#^/fhir/QuestionnaireResponse(/\$[a-z-]+)?/?$'
- '#^/fhir/PlanDefinition(/[^/]+)?(/\$[a-z-]+)?/?$'
request-method:
$one-of: [get, post, put, patch, delete]
```

### Form packages access

Form packages are stored as `PlanDefinition` resources. The **Forms** page reads them alongside questionnaires, so the SMART client needs access to that route as well. Without it, the forms list may not display correctly.

The `PlanDefinition` route is included in the policy above. If the policy was generated by the SMART setup in the Formbox UI, add the route manually:

```yaml
uri:
$one-of:
# keep the existing routes, then add
- '#^/fhir/PlanDefinition(/[^/]+)?(/\$[a-z-]+)?/?$'
```

`$one-of` is replaced as a whole rather than extended, so send the full list of routes with this one appended.

Including this route in the generated policy can be covered by request.

### Sandbox note

EHR sandboxes may require whitelisting or a support request before SMART launch is available in the provider UI.
Expand Down
Loading