Skip to main content

Form Applet

The Form Applet is a component designed to integrate structured data entry into a scenario workflow. It acts as a wrapper around the QuestionnaireRenderer, automatically handling the fetching and display of a FHIR Questionnaire based on a provided configuration.

This applet is typically used within a scenario to present specific forms—such as patient intakes, clinical assessments, or satisfaction surveys—referenced by their resource ID.

Configuration Overview​

The Form Applet is configured via the Config API using the FormAppletConfig interface. It requires a specific Questionnaire ID to determine which form to load from the server.

Properties Overview​

PropertyTypeRequiredDescription
questionnaireIdstringYesThe unique identifier of the FHIR Questionnaire to fetch

Property Details​

questionnaireId​

Type: string (required)

The unique identifier (ID) of the Questionnaire resource stored on the FHIR server.

The applet uses this ID combined with the application's environment baseUrl to construct the API request: {baseUrl}/Questionnaire/{questionnaireId}

export interface FormAppletConfig {
    questionnaireId: string | null;
}