Skip to content

add hidden fields facility for booking form #5363

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

Merged
VladMstv merged 2 commits into from
Dec 3, 2025
+106 −97
Merged

add hidden fields facility for booking form #5363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db0e8d0
add hidden fields facility for booking form
imbenham Dec 3, 2025
eb17738
variable name typo
imbenham Dec 3, 2025
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
200 changes: 104 additions & 96 deletions packages/utils/lib/configuration/booking/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ const bookAppointmentQuestionnaire: {
version: string | undefined;
templateQuestionnaire: Questionnaire | undefined;
} = (() => {
const templateResource = Object.values(bookAppointmentQuestionnaireJson.fhirResources)[0]?.resource;
const templateResource = _.cloneDeep(BookingQuestionnaire);
return {
url: templateResource?.url,
version: templateResource?.version,
Expand Down Expand Up @@ -97,100 +97,6 @@ interface BookingFormPrePopulationInput {
context: BookingContext;
patient?: Patient;
}
const prepopulateBookingForm = (input: BookingFormPrePopulationInput): QuestionnaireResponseItem[] => {
const {
patient,
questionnaire,
context: { serviceMode, serviceCategoryCode },
} = input;
console.log(
'making prepopulated items for booking form with serviceMode, serviceCategoryCode',
serviceMode,
serviceCategoryCode
);

let patientSex: string | undefined;
if (patient?.gender === 'male') {
patientSex = 'Male';
} else if (patient?.gender === 'female') {
patientSex = 'Female';
} else if (patient?.gender !== undefined) {
patientSex = 'Intersex';
}
const patientPreferredName = patient?.name?.find((name) => name.use === 'nickname')?.given?.[0];
const patientEmail = patient?.telecom?.find((c) => c.system === 'email' && c.period?.end === undefined)?.value;

const authorizedNLG = patient?.extension?.find(
(e) => e.url === FHIR_EXTENSION.Patient.authorizedNonLegalGuardians.url
)?.valueString;

const ssn = patient?.identifier?.find(
(id) =>
id.type?.coding?.some((c) => c.system === 'http://terminology.hl7.org/CodeSystem/v2-0203' && c.code === 'SS') &&
id.period?.end === undefined
)?.value;

// assuming here we never need to collect this when we already have it
const shouldShownSSNField = !ssn;
const ssnRequired = serviceCategoryCode === 'workmans_comp' && shouldShownSSNField;

const item: QuestionnaireResponseItem[] = (questionnaire.item ?? []).map((item) => {
const populatedItem: QuestionnaireResponseItem[] = (() => {
const itemItems = (item.item ?? [])
.filter((i: QuestionnaireItem) => i.type !== 'display')
.map((subItem) => {
const { linkId } = subItem;
let answer: QuestionnaireResponseItemAnswer[] | undefined;
if (linkId === 'existing-patient-id' && patient?.id) {
answer = makeAnswer(patient.id);
}
if (linkId === 'should-display-ssn-field') {
answer = makeAnswer(shouldShownSSNField, 'Boolean');
}
if (linkId === 'ssn-field-required') {
answer = makeAnswer(ssnRequired, 'Boolean');
}
if (linkId === 'patient-first-name' && patient) {
answer = makeAnswer(getFirstName(patient) ?? '');
}
if (linkId === 'patient-last-name' && patient) {
answer = makeAnswer(getLastName(patient) ?? '');
}

if (linkId === 'patient-middle-name' && patient) {
answer = makeAnswer(getMiddleName(patient) ?? '');
}
if (linkId === 'patient-preferred-name' && patientPreferredName) {
answer = makeAnswer(patientPreferredName);
}
if (linkId === 'patient-birthdate' && patient?.birthDate) {
answer = makeAnswer(patient.birthDate);
}
if (linkId === 'patient-birth-sex' && patientSex) {
answer = makeAnswer(patientSex);
}
if (linkId === 'patient-email' && patientEmail) {
answer = makeAnswer(patientEmail);
}
if (linkId === 'authorized-non-legal-guardian' && authorizedNLG) {
answer = makeAnswer(authorizedNLG);
}

return {
linkId,
answer,
};
});
return itemItems;
})();
return {
linkId: item.linkId,
item: populatedItem,
};
});

return item;
};

const mapBookingQRItemToPatientInfo = (qrItem: QuestionnaireResponseItem[]): PatientInfo => {
const items = flattenQuestionnaireAnswers(qrItem);
Expand Down Expand Up @@ -243,13 +149,20 @@ const mapBookingQRItemToPatientInfo = (qrItem: QuestionnaireResponseItem[]): Pat
return patientInfo;
};

type BookingQuestionnaireLinkId = NonNullable<
NonNullable<typeof BookingQuestionnaire.item>[number]['item']
>[number]['linkId'];

const hiddenBookingFields: BookingQuestionnaireLinkId[] = [];

const BOOKING_DEFAULTS = {
reasonForVisitOptions: REASON_FOR_VISIT_OPTIONS,
cancelReasonOptions: CANCEL_REASON_OPTIONS,
serviceCategoriesEnabled: {
serviceModes: ['in-person', 'virtual'],
visitType: ['prebook'],
},
hiddenBookingFields,
serviceCategories: SERVICE_CATEGORIES_AVAILABLE,
intakeQuestionnaires,
selectBookingQuestionnaire: (
Expand All @@ -266,10 +179,10 @@ const BOOKING_DEFAULTS = {
}
throw new Error('No booking questionnaire configured');
},
prepopulateBookingForm,
mapBookingQRItemToPatientInfo,
};

// todo: it would be nice to use zod to validate the merged booking config shape here
export const BOOKING_CONFIG = mergeAndFreezeConfigObjects(BOOKING_DEFAULTS, BOOKING_OVERRIDES);

export const shouldShowServiceCategorySelectionPage = (params: { serviceMode: string; visitType: string }): boolean => {
Expand All @@ -285,3 +198,98 @@ export const ServiceCategoryCodeSchema = z.enum(
);

export type ServiceCategoryCode = z.infer<typeof ServiceCategoryCodeSchema>;

export const prepopulateBookingForm = (input: BookingFormPrePopulationInput): QuestionnaireResponseItem[] => {
const {
patient,
questionnaire,
context: { serviceMode, serviceCategoryCode },
} = input;
console.log(
'making prepopulated items for booking form with serviceMode, serviceCategoryCode',
serviceMode,
serviceCategoryCode
);

let patientSex: string | undefined;
if (patient?.gender === 'male') {
patientSex = 'Male';
} else if (patient?.gender === 'female') {
patientSex = 'Female';
} else if (patient?.gender !== undefined) {
patientSex = 'Intersex';
}
const patientPreferredName = patient?.name?.find((name) => name.use === 'nickname')?.given?.[0];
const patientEmail = patient?.telecom?.find((c) => c.system === 'email' && c.period?.end === undefined)?.value;

const authorizedNLG = patient?.extension?.find(
(e) => e.url === FHIR_EXTENSION.Patient.authorizedNonLegalGuardians.url
)?.valueString;

const ssn = patient?.identifier?.find(
(id) =>
id.type?.coding?.some((c) => c.system === 'http://terminology.hl7.org/CodeSystem/v2-0203' && c.code === 'SS') &&
id.period?.end === undefined
)?.value;

// assuming here we never need to collect this when we already have it
const shouldShowSSNField = !ssn && !BOOKING_CONFIG.hiddenBookingFields.includes('patient-ssn');
const ssnRequired = serviceCategoryCode === 'workmans_comp' && shouldShowSSNField;

const item: QuestionnaireResponseItem[] = (questionnaire.item ?? []).map((item) => {
const populatedItem: QuestionnaireResponseItem[] = (() => {
const itemItems = (item.item ?? [])
.filter((i: QuestionnaireItem) => i.type !== 'display')
.map((subItem) => {
const { linkId } = subItem;
let answer: QuestionnaireResponseItemAnswer[] | undefined;
if (linkId === 'existing-patient-id' && patient?.id) {
answer = makeAnswer(patient.id);
}
if (linkId === 'should-display-ssn-field') {
answer = makeAnswer(shouldShowSSNField, 'Boolean');
}
if (linkId === 'ssn-field-required') {
answer = makeAnswer(ssnRequired, 'Boolean');
}
if (linkId === 'patient-first-name' && patient) {
answer = makeAnswer(getFirstName(patient) ?? '');
}
if (linkId === 'patient-last-name' && patient) {
answer = makeAnswer(getLastName(patient) ?? '');
}

if (linkId === 'patient-middle-name' && patient) {
answer = makeAnswer(getMiddleName(patient) ?? '');
}
if (linkId === 'patient-preferred-name' && patientPreferredName) {
answer = makeAnswer(patientPreferredName);
}
if (linkId === 'patient-birthdate' && patient?.birthDate) {
answer = makeAnswer(patient.birthDate);
}
if (linkId === 'patient-birth-sex' && patientSex) {
answer = makeAnswer(patientSex);
}
if (linkId === 'patient-email' && patientEmail) {
answer = makeAnswer(patientEmail);
}
if (linkId === 'authorized-non-legal-guardian' && authorizedNLG) {
answer = makeAnswer(authorizedNLG);
}

return {
linkId,
answer,
};
});
return itemItems;
})();
return {
linkId: item.linkId,
item: populatedItem,
};
});

return item;
};
3 changes: 2 additions & 1 deletion packages/zambdas/src/patient/paperwork/get-booking-questionnaire/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
INVALID_INPUT_ERROR,
mapQuestionnaireAndValueSetsToItemsList,
MISSING_REQUEST_BODY,
prepopulateBookingForm,
Secrets,
SecretsKeys,
ServiceCategoryCode,
Expand Down Expand Up @@ -87,7 +88,7 @@ const performEffect = async (input: EffectInput, oystehr: Oystehr): Promise<GetQ
const valueSets: ValueSet[] = [];
const allItems = mapQuestionnaireAndValueSetsToItemsList(items, valueSets);

const prepopulatedItem = BOOKING_CONFIG.prepopulateBookingForm({
const prepopulatedItem = prepopulateBookingForm({
questionnaire,
context: {
serviceMode,
Expand Down
Loading