@aehrc/smart-forms-renderer 0.3.0 → 0.5.0

package/src/index.ts

@@ -0,0 +1,163 @@
+import useQuestionnaireStore from './stores/useQuestionnaireStore';
+import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
+import { createQuestionnaireResponse } from './utils/qrItem';
+import useQuestionnaireResponseStore from './stores/useQuestionnaireResponseStore';
+import { removeHiddenAnswers } from './utils/removeHidden';
+
+export * from './components';
+export * from './hooks';
+
+/**
+ * Get the initial Questionnaire.
+ *
+ * @author Sean Fong
+ */
+export function useSourceQuestionnaire(): Questionnaire {
+  return useQuestionnaireStore.getState().sourceQuestionnaire;
+}
+
+/**
+ * Get the initial QuestionnaireResponse.
+ * An empty QuestionnaireResponse is returned if no initial QuestionnaireResponse is provided when building the form.
+ *
+ * @author Sean Fong
+ */
+export function useSourceResponse(): QuestionnaireResponse {
+  return useQuestionnaireResponseStore.getState().sourceResponse;
+}
+
+/**
+ * Get the filled QuestionnaireResponse.
+ * If no changes have been made to the form, the initial QuestionnaireResponse is returned.
+ *
+ * @author Sean Fong
+ */
+export function useUpdatableResponse(): QuestionnaireResponse {
+  return useQuestionnaireResponseStore.getState().updatableResponse;
+}
+
+/**
+ * Get the boolean value of whether any changes have been made to the form.
+ *
+ * @author Sean Fong
+ */
+export function useFormHasChanges(): boolean {
+  return useQuestionnaireResponseStore.getState().hasChanges;
+}
+
+/**
+ * Get the boolean value of whether enableWhen (and enableWhenExpression) is activated.
+ *
+ * @author Sean Fong
+ */
+export function useEnableWhenActivated(): boolean {
+  return useQuestionnaireStore.getState().enableWhenIsActivated;
+}
+
+/**
+ * Set the initial Questionnaire.
+ * In most cases, <pre>buildForm()</pre> should be used instead.
+ *
+ * @author Sean Fong
+ */
+export async function setSourceQuestionnaire(questionnaire: Questionnaire): Promise<void> {
+  await useQuestionnaireStore.getState().buildSourceQuestionnaire(questionnaire);
+}
+
+/**
+ * Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
+ * If a QuestionnaireResponse is not provided, an empty QuestionnaireResponse is set as the initial QuestionnaireResponse.
+ * In most cases, <pre>buildForm()</pre> is sufficient. Other fine-grained functions are provided for more control.
+ *
+ * @author Sean Fong
+ */
+export async function buildForm(
+  questionnaire: Questionnaire,
+  questionnaireResponse?: QuestionnaireResponse
+): Promise<void> {
+  await useQuestionnaireStore.getState().buildSourceQuestionnaire(questionnaire);
+
+  if (!questionnaireResponse) {
+    useQuestionnaireResponseStore
+      .getState()
+      .buildSourceResponse(createQuestionnaireResponse(questionnaire));
+    return;
+  }
+
+  useQuestionnaireResponseStore.getState().buildSourceResponse(questionnaireResponse);
+  useQuestionnaireStore.getState().updatePopulatedProperties(questionnaireResponse);
+}
+
+/**
+ * Destroy the form to clean up the store.
+ *
+ * @author Sean Fong
+ */
+export function destroyForm(): void {
+  useQuestionnaireStore.getState().destroySourceQuestionnaire();
+  useQuestionnaireResponseStore.getState().destroySourceResponse();
+}
+
+/**
+ * Toggle activation of enableWhen (and enableWhenExpression).
+ *
+ * @author Sean Fong
+ */
+export function setEnableWhenActivation(isActivated: boolean): void {
+  useQuestionnaireStore.getState().toggleEnableWhenActivation(isActivated);
+}
+
+/**
+ * Set the filled QuestionnaireResponse.
+ * In most cases, <pre>buildForm()</pre> should be used instead.
+ *
+ * @author Sean Fong
+ */
+export function setUpdatableResponse(populatedResponse: QuestionnaireResponse): void {
+  const updatedResponse = useQuestionnaireStore
+    .getState()
+    .updatePopulatedProperties(populatedResponse);
+  useQuestionnaireResponseStore.getState().populateResponse(updatedResponse);
+}
+
+/**
+ * Set the filled QuestionnaireResponse to be empty.
+ * This is used to quickly clear the form.
+ *
+ * @author Sean Fong
+ */
+export function setUpdatableResponseAsEmpty(emptyResponse: QuestionnaireResponse): void {
+  return useQuestionnaireResponseStore.getState().clearResponse(emptyResponse);
+}
+
+/**
+ * Save the filled QuestionnaireResponse to be the initial QuestionnaireResponse and reset the <pre>hasChanges</pre> flag.
+ *
+ * @author Sean Fong
+ */
+export function setUpdatableResponseAsSaved(savedResponse: QuestionnaireResponse): void {
+  return useQuestionnaireResponseStore.getState().saveResponse(savedResponse);
+}
+
+/**
+ * Remove all hidden answers from the filled QuestionnaireResponse.
+ * This takes into account the questionnaire-hidden extension, enableWhens and enableWhenExpressions.
+ *
+ * @author Sean Fong
+ */
+export function removeHiddenAnswersFromResponse(
+  questionnaire: Questionnaire,
+  questionnaireResponse: QuestionnaireResponse
+): QuestionnaireResponse {
+  const enableWhenIsActivated = useQuestionnaireStore.getState().enableWhenIsActivated;
+  const enableWhenItems = useQuestionnaireStore.getState().enableWhenItems;
+  const enableWhenExpressions = useQuestionnaireStore.getState().enableWhenExpressions;
+
+  return removeHiddenAnswers({
+    questionnaire,
+    questionnaireResponse,
+    enableWhenIsActivated,
+    enableWhenItems,
+    enableWhenExpressions
+  });
+}

package/src/interfaces/answerExpression.interface.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { QuestionnaireItemAnswerOption } from 'fhir/r4';
+
+export interface AnswerExpression {
+  expression: string;
+  value?: QuestionnaireItemAnswerOption;
+}

package/src/interfaces/calculatedExpression.interface.ts

@@ -0,0 +1,4 @@
+export interface CalculatedExpression {
+  expression: string;
+  value?: number | string;
+}

package/src/interfaces/choice.enum.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export enum QItemChoiceControl {
+  Radio = 'radio',
+  Select = 'select',
+  Autocomplete = 'autocomplete',
+  Checkbox = 'check-box'
+}
+
+export enum QItemOpenChoiceControl {
+  Select = 'select',
+  Autocomplete = 'autocomplete',
+  Checkbox = 'check-box',
+  Radio = 'radio'
+}
+
+export enum QItemChoiceOrientation {
+  Horizontal = 'horizontal',
+  Vertical = 'vertical'
+}
+
+export enum CheckBoxOptionType {
+  AnswerOption = 'answerOption',
+  AnswerValueSet = 'answerValueSet'
+}

package/src/interfaces/enableWhen.interface.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type {
+  QuestionnaireItem,
+  QuestionnaireItemEnableWhen,
+  QuestionnaireResponseItemAnswer
+} from 'fhir/r4';
+
+export interface EnableWhenExpression {
+  expression: string;
+  isEnabled?: boolean;
+}
+
+export type EnableWhenItems = Record<string, EnableWhenItemProperties>;
+
+export interface EnableWhenItemProperties {
+  linked: EnableWhenLinkedItem[];
+  isEnabled: boolean;
+  enableBehavior?: QuestionnaireItem['enableBehavior'];
+}
+
+export interface EnableWhenLinkedItem {
+  enableWhen: QuestionnaireItemEnableWhen;
+  answer?: QuestionnaireResponseItemAnswer[];
+}

package/src/interfaces/groupTable.interface.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { QuestionnaireResponseItem } from 'fhir/r4';
+
+export interface GroupTableRow {
+  nanoId: string;
+  qrItem: QuestionnaireResponseItem | null;
+}

package/src/interfaces/populate.interface.ts

@@ -0,0 +1,218 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Coding, Expression, Extension, Reference } from 'fhir/r4';
+
+export interface LaunchContext extends Extension {
+  url: 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext';
+  extension: LaunchContextExtensions;
+}
+
+type LaunchContextExtensions =
+  | [LaunchContextName, LaunchContextType]
+  | [LaunchContextName, LaunchContextType, LaunchContextDescription];
+
+type LaunchContextName = LaunchContextNameId | LaunchContextNameCoding;
+
+// for backwards compatibility with old questionnaires (though it is not conformant)
+interface LaunchContextNameId extends Extension {
+  url: 'name';
+  valueId: string;
+}
+
+interface LaunchContextNameCoding extends Extension {
+  url: 'name';
+  valueCoding: LaunchContextNameCodingValueCoding;
+}
+
+interface LaunchContextNameCodingValueCoding extends Coding {
+  code: 'patient' | 'encounter' | 'location' | 'user' | 'study';
+}
+
+interface LaunchContextType extends Extension {
+  url: 'type';
+  valueCode: FhirResourceString;
+}
+
+interface LaunchContextDescription extends Extension {
+  url: 'description';
+  valueString: string;
+}
+
+export type FhirResourceString =
+  | 'Account'
+  | 'ActivityDefinition'
+  | 'AdverseEvent'
+  | 'AllergyIntolerance'
+  | 'Appointment'
+  | 'AppointmentResponse'
+  | 'AuditEvent'
+  | 'Basic'
+  | 'Binary'
+  | 'BiologicallyDerivedProduct'
+  | 'BodyStructure'
+  | 'Bundle'
+  | 'CapabilityStatement'
+  | 'CarePlan'
+  | 'CareTeam'
+  | 'CatalogEntry'
+  | 'ChargeItem'
+  | 'ChargeItemDefinition'
+  | 'Claim'
+  | 'ClaimResponse'
+  | 'ClinicalImpression'
+  | 'CodeSystem'
+  | 'Communication'
+  | 'CommunicationRequest'
+  | 'CompartmentDefinition'
+  | 'Composition'
+  | 'ConceptMap'
+  | 'Condition'
+  | 'Consent'
+  | 'Contract'
+  | 'Coverage'
+  | 'CoverageEligibilityRequest'
+  | 'CoverageEligibilityResponse'
+  | 'DetectedIssue'
+  | 'Device'
+  | 'DeviceDefinition'
+  | 'DeviceMetric'
+  | 'DeviceRequest'
+  | 'DeviceUseStatement'
+  | 'DiagnosticReport'
+  | 'DocumentManifest'
+  | 'DocumentReference'
+  | 'EffectEvidenceSynthesis'
+  | 'Encounter'
+  | 'Endpoint'
+  | 'EnrollmentRequest'
+  | 'EnrollmentResponse'
+  | 'EpisodeOfCare'
+  | 'EventDefinition'
+  | 'Evidence'
+  | 'EvidenceVariable'
+  | 'ExampleScenario'
+  | 'ExplanationOfBenefit'
+  | 'FamilyMemberHistory'
+  | 'Flag'
+  | 'Goal'
+  | 'GraphDefinition'
+  | 'Group'
+  | 'GuidanceResponse'
+  | 'HealthcareService'
+  | 'ImagingStudy'
+  | 'Immunization'
+  | 'ImmunizationEvaluation'
+  | 'ImmunizationRecommendation'
+  | 'ImplementationGuide'
+  | 'InsurancePlan'
+  | 'Invoice'
+  | 'Library'
+  | 'Linkage'
+  | 'List'
+  | 'Location'
+  | 'Measure'
+  | 'MeasureReport'
+  | 'Media'
+  | 'Medication'
+  | 'MedicationAdministration'
+  | 'MedicationDispense'
+  | 'MedicationKnowledge'
+  | 'MedicationRequest'
+  | 'MedicationStatement'
+  | 'MedicinalProduct'
+  | 'MedicinalProductAuthorization'
+  | 'MedicinalProductContraindication'
+  | 'MedicinalProductIndication'
+  | 'MedicinalProductIngredient'
+  | 'MedicinalProductInteraction'
+  | 'MedicinalProductManufactured'
+  | 'MedicinalProductPackaged'
+  | 'MedicinalProductPharmaceutical'
+  | 'MedicinalProductUndesirableEffect'
+  | 'MessageDefinition'
+  | 'MessageHeader'
+  | 'MolecularSequence'
+  | 'NamingSystem'
+  | 'NutritionOrder'
+  | 'Observation'
+  | 'ObservationDefinition'
+  | 'OperationDefinition'
+  | 'OperationOutcome'
+  | 'Organization'
+  | 'OrganizationAffiliation'
+  | 'Parameters'
+  | 'Patient'
+  | 'PaymentNotice'
+  | 'PaymentReconciliation'
+  | 'Person'
+  | 'PlanDefinition'
+  | 'Practitioner'
+  | 'PractitionerRole'
+  | 'Procedure'
+  | 'Provenance'
+  | 'Questionnaire'
+  | 'QuestionnaireResponse'
+  | 'RelatedPerson'
+  | 'RequestGroup'
+  | 'ResearchDefinition'
+  | 'ResearchElementDefinition'
+  | 'ResearchStudy'
+  | 'ResearchSubject'
+  | 'RiskAssessment'
+  | 'RiskEvidenceSynthesis'
+  | 'Schedule'
+  | 'SearchParameter'
+  | 'ServiceRequest'
+  | 'Slot'
+  | 'Specimen'
+  | 'SpecimenDefinition'
+  | 'StructureDefinition'
+  | 'StructureMap'
+  | 'Subscription'
+  | 'Substance'
+  | 'SubstanceNucleicAcid'
+  | 'SubstancePolymer'
+  | 'SubstanceProtein'
+  | 'SubstanceReferenceInformation'
+  | 'SubstanceSourceMaterial'
+  | 'SubstanceSpecification'
+  | 'SupplyDelivery'
+  | 'SupplyRequest'
+  | 'Task'
+  | 'TerminologyCapabilities'
+  | 'TestReport'
+  | 'TestScript'
+  | 'ValueSet'
+  | 'VerificationResult'
+  | 'VisionPrescription';
+
+export interface SourceQuery extends Extension {
+  url: 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceQueries';
+  valueReference: Reference;
+}
+
+export interface QuestionnaireLevelXFhirQueryVariable extends Extension {
+  url: 'http://hl7.org/fhir/StructureDefinition/variable';
+  valueExpression: XFhirQueryVariableExpression;
+}
+
+interface XFhirQueryVariableExpression extends Expression {
+  name: string;
+  language: 'application/x-fhir-query';
+  expression: string;
+}

package/src/interfaces/questionnaireStore.interface.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Tabs } from 'smart-forms-app/src/features/renderer/types/tab.interface';
+import type { Variables } from './variables.interface';
+import type { LaunchContext } from './populate.interface';
+import type { EnableWhenExpression, EnableWhenItemProperties } from './enableWhen.interface';
+import type { CalculatedExpression } from './calculatedExpression.interface';
+import type { AnswerExpression } from './answerExpression.interface';
+import type { Coding } from 'fhir/r4';
+
+export interface QuestionnaireModel {
+  tabs: Tabs;
+  variables: Variables;
+  launchContexts: Record<string, LaunchContext>;
+  enableWhenItems: Record<string, EnableWhenItemProperties>;
+  enableWhenExpressions: Record<string, EnableWhenExpression>;
+  calculatedExpressions: Record<string, CalculatedExpression>;
+  answerExpressions: Record<string, AnswerExpression>;
+  processedValueSetCodings: Record<string, Coding[]>;
+  processedValueSetUrls: Record<string, string>;
+}

package/src/interfaces/regex.interface.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface RegexValidation {
+  expression: RegExp;
+  feedback: string | null;
+}

package/src/interfaces/renderProps.interface.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { QrRepeatGroup } from './repeatGroup.interface';
+
+export interface PropsWithQrItemChangeHandler<QuestionnaireResponseItem> {
+  onQrItemChange: (qrItem: QuestionnaireResponseItem) => unknown;
+}
+
+export interface PropsWithQrRepeatGroupChangeHandler {
+  onQrRepeatGroupChange: (qrRepeatGroup: QrRepeatGroup) => unknown;
+}
+
+export interface PropsWithIsRepeatedAttribute {
+  isRepeated: boolean;
+}
+
+export interface PropsWithIsTabledAttribute {
+  isTabled: boolean;
+}

package/src/interfaces/repeatGroup.interface.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { QuestionnaireResponseItem } from 'fhir/r4';
+
+export interface QrRepeatGroup {
+  linkId: string;
+  qrItems: QuestionnaireResponseItem[];
+}
+
+export interface RepeatGroupSingle {
+  nanoId: string;
+  qrItem: QuestionnaireResponseItem | null;
+}

package/src/interfaces/repeatItem.interface.ts

@@ -0,0 +1,6 @@
+import type { QuestionnaireResponseItemAnswer } from 'fhir/r4';
+
+export interface RepeatAnswer {
+  nanoId: string;
+  answer: QuestionnaireResponseItemAnswer | null;
+}

package/src/interfaces/tab.interface.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export type Tab = { tabIndex: number; isComplete: boolean; isHidden: boolean };
+export type Tabs = Record<string, Tab>;

package/src/interfaces/valueSet.interface.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { ValueSet } from 'fhir/r4';
+
+export interface ValueSetPromise {
+  promise: Promise<ValueSet>;
+  valueSet?: ValueSet;
+}