Skip to content

(docs): Document FDE integration with RFE/AFE and pre-filled questions#141

Merged
samuelmale merged 2 commits intoopenmrs:mainfrom
Twiineenock:feat/update-READme
Sep 2, 2025
Merged

(docs): Document FDE integration with RFE/AFE and pre-filled questions#141
samuelmale merged 2 commits intoopenmrs:mainfrom
Twiineenock:feat/update-READme

Conversation

@Twiineenock
Copy link
Contributor

Requirements

  • This PR has a title that briefly describes the work done, including the ticket number if there is a ticket.
  • My work conforms to the OpenMRS 3.0 Styleguide.
  • My work includes tests or is validated by existing tests.

Summary

Proceeding from Fix FDE for RFE forms instances, this PR updates the README.md to highlight the flexibility of FDE with both Angular and React form engines and adds detailed documentation for pre-filled/specific questions.

Screenshots

Related Issue

Other

@Twiineenock
Copy link
Contributor Author

CC @samuelmale

README.md Outdated
* Identify **which forms** the question applies to.
* Point to the **question ID** within the form schema.
* Optionally define a **default answer**.
* Optionally limit the set of **answer choices** (for multi-select fields).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(for multi-select fields).

Does this only apply to multi-select inputs or all coded inputs, such as drop-downs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, slipped past me — Great observation.

README.md Outdated
* **`forms`**: Array of form UUIDs. The pre-fill rule applies only to these forms.
* **`questionId`**: The field identifier in the form schema to pre-fill. Must exist in the published form schema.
* **`defaultAnswer`** *(optional)*: A concept UUID or value to use as the default answer.
* **`answers`** *(optional, multi-select only)*: Array of concept UUIDs to restrict the available answer options.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

README.md Outdated
- [Form Engine App](https://github.com/openmrs/openmrs-esm-patient-chart/tree/main/packages/esm-form-engine-app)
- [Form Entry App](https://github.com/openmrs/openmrs-esm-patient-chart/tree/main/packages/esm-form-entry-app)

⚠️ **Important**: Only one wrapper can be active in a distribution. A distribution must choose either the **React-based** or **Angular-based** engine, depending on its architecture.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, there are O3 distribution(s) using the HTML Form Entry (HFE) engine. That being said, let's rephrase the above statement to echo that the FDE feature is currently limited to JSON schema-based engines, etc..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caught me there — thanks!
Does that mean that the such distributions don't have hopes of using the FDE module?
CC @samuelmale @ibacher

@samuelmale samuelmale merged commit 50dc98a into openmrs:main Sep 2, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants