@openmrs/esm-framework 6.3.1-pre.3092 → 6.3.1-pre.3104
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/dist/openmrs-esm-framework.js +2 -2
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +310 -8579
- package/docs/classes/OpenmrsFetchError.md +88 -117
- package/docs/enumerations/Type.md +77 -0
- package/docs/enumerations/VisitMode.md +29 -0
- package/docs/enumerations/VisitStatus.md +21 -0
- package/docs/functions/ConfigurableLink.md +19 -0
- package/docs/functions/CustomOverflowMenu.md +17 -0
- package/docs/functions/DashboardExtension.md +17 -0
- package/docs/functions/ExtensionSlot.md +46 -0
- package/docs/functions/OpenmrsAppContext.md +36 -0
- package/docs/functions/PatientBannerActionsMenu.md +17 -0
- package/docs/functions/PatientBannerContactDetails.md +17 -0
- package/docs/functions/PatientBannerPatientIdentifiers.md +17 -0
- package/docs/functions/PatientBannerPatientInfo.md +17 -0
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +17 -0
- package/docs/functions/PatientPhoto.md +19 -0
- package/docs/functions/WorkspaceContainer.md +55 -0
- package/docs/functions/age.md +32 -0
- package/docs/functions/attach.md +40 -0
- package/docs/functions/beginEditSynchronizationItem.md +22 -0
- package/docs/functions/canAccessStorage.md +25 -0
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +22 -0
- package/docs/functions/clearCurrentUser.md +11 -0
- package/docs/functions/closeWorkspace.md +27 -0
- package/docs/functions/compile.md +30 -0
- package/docs/functions/convertToLocaleCalendar.md +25 -0
- package/docs/functions/createAttachment.md +21 -0
- package/docs/functions/createErrorHandler.md +21 -0
- package/docs/functions/createGlobalStore.md +36 -0
- package/docs/functions/createUseStore.md +66 -0
- package/docs/functions/defineConfigSchema.md +33 -0
- package/docs/functions/defineExtensionConfigSchema.md +38 -0
- package/docs/functions/deleteAttachmentPermanently.md +21 -0
- package/docs/functions/deleteSynchronizationItem.md +21 -0
- package/docs/functions/detach.md +25 -0
- package/docs/functions/detachAll.md +21 -0
- package/docs/functions/dispatchNotificationShown.md +17 -0
- package/docs/functions/dispatchPrecacheStaticDependencies.md +17 -0
- package/docs/functions/displayName.md +21 -0
- package/docs/functions/evaluate.md +84 -0
- package/docs/functions/evaluateAsBoolean.md +31 -0
- package/docs/functions/evaluateAsBooleanAsync.md +31 -0
- package/docs/functions/evaluateAsNumber.md +31 -0
- package/docs/functions/evaluateAsNumberAsync.md +31 -0
- package/docs/functions/evaluateAsType.md +46 -0
- package/docs/functions/evaluateAsTypeAsync.md +46 -0
- package/docs/functions/evaluateAsync.md +87 -0
- package/docs/functions/extractVariableNames.md +50 -0
- package/docs/functions/fetchCurrentPatient.md +25 -0
- package/docs/functions/filterBreadcrumbs.md +21 -0
- package/docs/functions/formatDate.md +39 -0
- package/docs/functions/formatDatetime.md +29 -0
- package/docs/functions/formatPartialDate.md +39 -0
- package/docs/functions/formatPatientName.md +23 -0
- package/docs/functions/formatTime.md +20 -0
- package/docs/functions/formattedName.md +21 -0
- package/docs/functions/generateOfflineUuid.md +13 -0
- package/docs/functions/getAssignedExtensions.md +23 -0
- package/docs/functions/getAsyncLifecycle.md +31 -0
- package/docs/functions/getAttachmentByUuid.md +21 -0
- package/docs/functions/getAttachments.md +25 -0
- package/docs/functions/getBreadcrumbs.md +11 -0
- package/docs/functions/getBreadcrumbsFor.md +17 -0
- package/docs/functions/getConfig.md +31 -0
- package/docs/functions/getContext.md +29 -0
- package/docs/functions/getCoreTranslation.md +35 -0
- package/docs/functions/getCurrentOfflineMode.md +11 -0
- package/docs/functions/getCurrentUser.md +154 -0
- package/docs/functions/getDefaultCalendar.md +21 -0
- package/docs/functions/getDefaultsFromConfigSchema.md +32 -0
- package/docs/functions/getDynamicOfflineDataEntries.md +28 -0
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +34 -0
- package/docs/functions/getDynamicOfflineDataHandlers.md +13 -0
- package/docs/functions/getExtensionNameFromId.md +30 -0
- package/docs/functions/getExtensionStore.md +14 -0
- package/docs/functions/getFeatureFlag.md +21 -0
- package/docs/functions/getFhirServerPaginationHandlers.md +17 -0
- package/docs/functions/getFullSynchronizationItems.md +27 -0
- package/docs/functions/getFullSynchronizationItemsFor.md +33 -0
- package/docs/functions/getGlobalStore.md +36 -0
- package/docs/functions/getHistory.md +13 -0
- package/docs/functions/getLifecycle.md +27 -0
- package/docs/functions/getLocale.md +15 -0
- package/docs/functions/getLocations.md +21 -0
- package/docs/functions/getLoggedInUser.md +11 -0
- package/docs/functions/getOfflinePatientDataStore.md +15 -0
- package/docs/functions/getPatientName.md +26 -0
- package/docs/functions/getSessionLocation.md +11 -0
- package/docs/functions/getSessionStore.md +11 -0
- package/docs/functions/getSyncLifecycle.md +31 -0
- package/docs/functions/getSynchronizationItem.md +27 -0
- package/docs/functions/getSynchronizationItems.md +27 -0
- package/docs/functions/getVisitStore.md +11 -0
- package/docs/functions/getVisitTypes.md +11 -0
- package/docs/functions/getVisitsForPatient.md +29 -0
- package/docs/functions/goBackInHistory.md +25 -0
- package/docs/functions/importDynamic.md +58 -0
- package/docs/functions/inRange.md +27 -0
- package/docs/functions/interpolateString.md +34 -0
- package/docs/functions/interpolateUrl.md +48 -0
- package/docs/functions/isDesktop.md +17 -0
- package/docs/functions/isDevEnabled.md +11 -0
- package/docs/functions/isOfflineUuid.md +19 -0
- package/docs/functions/isOmrsDateStrict.md +20 -0
- package/docs/functions/isOmrsDateToday.md +19 -0
- package/docs/functions/isOnline.md +17 -0
- package/docs/functions/isUrlWithTemplateParameters.md +22 -0
- package/docs/functions/isVersionSatisfied.md +21 -0
- package/docs/functions/launchWorkspace.md +56 -0
- package/docs/functions/launchWorkspaceGroup.md +38 -0
- package/docs/functions/makeUrl.md +26 -0
- package/docs/functions/messageOmrsServiceWorker.md +23 -0
- package/docs/functions/navigate.md +48 -0
- package/docs/functions/navigateAndLaunchWorkspace.md +33 -0
- package/docs/functions/oneOf.md +21 -0
- package/docs/functions/openmrsFetch.md +75 -0
- package/docs/functions/openmrsObservableFetch.md +55 -0
- package/docs/functions/parseDate.md +20 -0
- package/docs/functions/provide.md +21 -0
- package/docs/functions/putDynamicOfflineData.md +28 -0
- package/docs/functions/putDynamicOfflineDataFor.md +34 -0
- package/docs/functions/queueSynchronizationItem.md +39 -0
- package/docs/functions/refetchCurrentUser.md +33 -0
- package/docs/functions/registerBreadcrumb.md +17 -0
- package/docs/functions/registerBreadcrumbs.md +17 -0
- package/docs/functions/registerContext.md +34 -0
- package/docs/functions/registerDefaultCalendar.md +33 -0
- package/docs/functions/registerFeatureFlag.md +36 -0
- package/docs/functions/registerOfflinePatientHandler.md +25 -0
- package/docs/functions/removeDynamicOfflineData.md +28 -0
- package/docs/functions/removeDynamicOfflineDataFor.md +34 -0
- package/docs/functions/renderExtension.md +41 -0
- package/docs/functions/reportError.md +17 -0
- package/docs/functions/retry.md +44 -0
- package/docs/functions/saveVisit.md +21 -0
- package/docs/functions/selectPreferredName.md +46 -0
- package/docs/functions/setCurrentVisit.md +21 -0
- package/docs/functions/setLeftNav.md +23 -0
- package/docs/functions/setSessionLocation.md +21 -0
- package/docs/functions/setUserLanguage.md +17 -0
- package/docs/functions/setUserProperties.md +23 -0
- package/docs/functions/setupDynamicOfflineDataHandler.md +22 -0
- package/docs/functions/setupOfflineSync.md +49 -0
- package/docs/functions/shallowEqual.md +32 -0
- package/docs/functions/showActionableNotification.md +21 -0
- package/docs/functions/showModal.md +44 -0
- package/docs/functions/showNotification.md +21 -0
- package/docs/functions/showSnackbar.md +21 -0
- package/docs/functions/showToast.md +21 -0
- package/docs/functions/subscribeActionableNotificationShown.md +21 -0
- package/docs/functions/subscribeConnectivity.md +21 -0
- package/docs/functions/subscribeConnectivityChanged.md +21 -0
- package/docs/functions/subscribeNotificationShown.md +21 -0
- package/docs/functions/subscribePrecacheStaticDependencies.md +21 -0
- package/docs/functions/subscribeSnackbarShown.md +21 -0
- package/docs/functions/subscribeTo.md +75 -0
- package/docs/functions/subscribeToContext.md +39 -0
- package/docs/functions/subscribeToastShown.md +21 -0
- package/docs/functions/syncAllDynamicOfflineData.md +27 -0
- package/docs/functions/syncDynamicOfflineData.md +33 -0
- package/docs/functions/syncOfflinePatientData.md +21 -0
- package/docs/functions/toDateObjectStrict.md +20 -0
- package/docs/functions/toLocationObject.md +17 -0
- package/docs/functions/toOmrsIsoString.md +23 -0
- package/docs/functions/toVisitTypeObject.md +17 -0
- package/docs/functions/translateFrom.md +55 -0
- package/docs/functions/unregisterContext.md +20 -0
- package/docs/functions/unsetLeftNav.md +23 -0
- package/docs/functions/updateContext.md +29 -0
- package/docs/functions/updateVisit.md +25 -0
- package/docs/functions/useAbortController.md +32 -0
- package/docs/functions/useAppContext.md +43 -0
- package/docs/functions/useAssignedExtensionIds.md +26 -0
- package/docs/functions/useAssignedExtensions.md +21 -0
- package/docs/functions/useAttachments.md +41 -0
- package/docs/functions/useBodyScrollLock.md +17 -0
- package/docs/functions/useConfig.md +27 -0
- package/docs/functions/useConnectivity.md +11 -0
- package/docs/functions/useDebounce.md +57 -0
- package/docs/functions/useDefineAppContext.md +70 -0
- package/docs/functions/useEmrConfiguration.md +35 -0
- package/docs/functions/useExtensionSlotMeta.md +25 -0
- package/docs/functions/useExtensionSlotStore.md +17 -0
- package/docs/functions/useFeatureFlag.md +30 -0
- package/docs/functions/useFhirFetchAll.md +44 -0
- package/docs/functions/useFhirInfinite.md +46 -0
- package/docs/functions/useFhirPagination.md +129 -0
- package/docs/functions/useLayoutType.md +11 -0
- package/docs/functions/useLeftNav.md +17 -0
- package/docs/functions/useLeftNavStore.md +11 -0
- package/docs/functions/useLocations.md +21 -0
- package/docs/functions/useOnClickOutside.md +27 -0
- package/docs/functions/useOnVisible.md +28 -0
- package/docs/functions/useOpenmrsFetchAll.md +46 -0
- package/docs/functions/useOpenmrsInfinite.md +54 -0
- package/docs/functions/useOpenmrsPagination.md +140 -0
- package/docs/functions/useOpenmrsSWR.md +71 -0
- package/docs/functions/usePagination.md +89 -0
- package/docs/functions/usePatient.md +38 -0
- package/docs/functions/usePatientPhoto.md +17 -0
- package/docs/functions/usePrimaryIdentifierCode.md +23 -0
- package/docs/functions/useRenderableExtensions.md +43 -0
- package/docs/functions/useSession.md +19 -0
- package/docs/functions/useStore.md +131 -0
- package/docs/functions/useStoreWithActions.md +33 -0
- package/docs/functions/useVisit.md +41 -0
- package/docs/functions/useVisitContextStore.md +23 -0
- package/docs/functions/useVisitTypes.md +11 -0
- package/docs/functions/useWorkspaces.md +11 -0
- package/docs/functions/userHasAccess.md +27 -0
- package/docs/functions/validator.md +44 -0
- package/docs/interfaces/ActionMenuButtonProps.md +33 -57
- package/docs/interfaces/ActionableNotificationDescriptor.md +37 -67
- package/docs/interfaces/AssignedExtension.md +30 -57
- package/docs/interfaces/Attachment.md +23 -47
- package/docs/interfaces/AttachmentResponse.md +20 -41
- package/docs/interfaces/AuditInfo.md +49 -88
- package/docs/interfaces/BreadcrumbRegistration.md +8 -17
- package/docs/interfaces/BreadcrumbSettings.md +18 -33
- package/docs/interfaces/CancelLoading.md +6 -10
- package/docs/interfaces/ClearDynamicRoutesMessage.md +9 -17
- package/docs/interfaces/CloseWorkspaceOptions.md +18 -29
- package/docs/interfaces/ComponentConfig.md +11 -23
- package/docs/interfaces/Concept.md +83 -131
- package/docs/interfaces/ConceptClass.md +46 -67
- package/docs/interfaces/ConceptDatatype.md +50 -74
- package/docs/interfaces/ConceptName.md +50 -74
- package/docs/interfaces/Config.md +4 -2
- package/docs/interfaces/ConfigObject.md +12 -21
- package/docs/interfaces/ConfigSchema.md +15 -27
- package/docs/interfaces/ConfigurableLinkProps.md +24 -4314
- package/docs/interfaces/ConnectedExtension.md +25 -41
- package/docs/interfaces/ConnectivityChangedEvent.md +4 -10
- package/docs/interfaces/CurrentPatientOptions.md +9 -18
- package/docs/interfaces/DashboardExtensionProps.md +13 -28
- package/docs/interfaces/DefaultWorkspaceProps.md +44 -51
- package/docs/interfaces/Diagnosis.md +80 -104
- package/docs/interfaces/DisplayConditionsConfigObject.md +18 -33
- package/docs/interfaces/DynamicOfflineData.md +23 -41
- package/docs/interfaces/DynamicOfflineDataHandler.md +47 -54
- package/docs/interfaces/DynamicOfflineDataSyncState.md +29 -39
- package/docs/interfaces/EmrApiConfigurationResponse.md +243 -350
- package/docs/interfaces/Encounter.md +67 -110
- package/docs/interfaces/EncounterProvider.md +39 -61
- package/docs/interfaces/EncounterRole.md +43 -68
- package/docs/interfaces/EncounterType.md +43 -68
- package/docs/interfaces/ErrorStateProps.md +7 -16
- package/docs/interfaces/ExtensionData.md +10 -22
- package/docs/interfaces/ExtensionMeta.md +4 -2
- package/docs/interfaces/ExtensionRegistration.md +36 -69
- package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
- package/docs/interfaces/ExtensionSlotConfig.md +17 -32
- package/docs/interfaces/ExtensionSlotConfigObject.md +14 -26
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +4 -2
- package/docs/interfaces/ExtensionSlotProps.md +3520 -0
- package/docs/interfaces/ExtensionSlotState.md +9 -18
- package/docs/interfaces/ExtensionStore.md +5 -11
- package/docs/interfaces/FHIRCode.md +11 -23
- package/docs/interfaces/FHIRLocationResource.md +25 -18
- package/docs/interfaces/FHIRResource.md +105 -41
- package/docs/interfaces/FeatureFlagDefinition.md +14 -26
- package/docs/interfaces/FetchConfig.md +80 -117
- package/docs/interfaces/FetchError.md +8 -21
- package/docs/interfaces/FetchHeaders.md +4 -2
- package/docs/interfaces/FetchResponse.md +124 -130
- package/docs/interfaces/FetchResponseJson.md +4 -2
- package/docs/interfaces/ImportMap.md +4 -10
- package/docs/interfaces/LeftNavStore.md +14 -29
- package/docs/interfaces/Link.md +11 -23
- package/docs/interfaces/Location.md +147 -250
- package/docs/interfaces/LoggedInUser.md +68 -70
- package/docs/interfaces/LoggedInUserFetchResponse.md +120 -128
- package/docs/interfaces/MessageServiceWorkerResult.md +17 -29
- package/docs/interfaces/NavigateOptions.md +9 -18
- package/docs/interfaces/NewVisitPayload.md +32 -48
- package/docs/interfaces/NotificationDescriptor.md +31 -58
- package/docs/interfaces/Obs.md +99 -166
- package/docs/interfaces/OfflineModeResult.md +11 -23
- package/docs/interfaces/OfflinePatientArgs.md +13 -20
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +17 -27
- package/docs/interfaces/OfflinePatientDataSyncState.md +29 -51
- package/docs/interfaces/OfflinePatientDataSyncStore.md +13 -20
- package/docs/interfaces/OmrsServiceWorkerMessage.md +13 -23
- package/docs/interfaces/OnImportMapChangedMessage.md +12 -23
- package/docs/interfaces/OnlyThePatient.md +9 -17
- package/docs/interfaces/OpenWorkspace.md +116 -170
- package/docs/interfaces/OpenmrsAppContextProps.md +14 -23
- package/docs/interfaces/OpenmrsAppRoutes.md +41 -71
- package/docs/interfaces/OpenmrsDatePickerProps.md +346 -483
- package/docs/interfaces/OpenmrsResource.md +39 -57
- package/docs/interfaces/OpenmrsResourceStrict.md +27 -51
- package/docs/interfaces/PageHeaderContentProps.md +12 -24
- package/docs/interfaces/PageHeaderWrapperProps.md +9 -18
- package/docs/interfaces/Patient.md +41 -70
- package/docs/interfaces/PatientBannerActionsMenuProps.md +15 -30
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +17 -32
- package/docs/interfaces/PatientIdentifier.md +49 -84
- package/docs/interfaces/PatientIdentifierType.md +65 -112
- package/docs/interfaces/PatientPhotoProps.md +8 -17
- package/docs/interfaces/PatientWithFullResponse.md +9 -17
- package/docs/interfaces/Person.md +96 -160
- package/docs/interfaces/PersonAddress.md +136 -230
- package/docs/interfaces/PersonAttribute.md +43 -68
- package/docs/interfaces/PersonName.md +72 -118
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +3 -1
- package/docs/interfaces/PrimaryIdentifier.md +5 -11
- package/docs/interfaces/Privilege.md +11 -23
- package/docs/interfaces/Prompt.md +20 -41
- package/docs/interfaces/QueueItemDescriptor.md +23 -30
- package/docs/interfaces/RegisterDynamicRouteMessage.md +21 -38
- package/docs/interfaces/ResourceLoader.md +10 -14
- package/docs/interfaces/ResponsiveWrapperProps.md +5 -11
- package/docs/interfaces/RetryOptions.md +36 -37
- package/docs/interfaces/Role.md +10 -22
- package/docs/interfaces/Session.md +31 -54
- package/docs/interfaces/SessionLocation.md +10 -22
- package/docs/interfaces/SetLeftNavParams.md +15 -30
- package/docs/interfaces/ShowActionableNotificationEvent.md +26 -50
- package/docs/interfaces/ShowNotificationEvent.md +20 -38
- package/docs/interfaces/ShowSnackbarEvent.md +34 -64
- package/docs/interfaces/ShowToastEvent.md +22 -43
- package/docs/interfaces/SnackbarDescriptor.md +41 -76
- package/docs/interfaces/SnackbarMeta.md +55 -93
- package/docs/interfaces/SpaConfig.md +30 -40
- package/docs/interfaces/StyleguideConfigObject.md +39 -70
- package/docs/interfaces/SyncItem.md +34 -57
- package/docs/interfaces/SyncProcessOptions.md +22 -40
- package/docs/interfaces/ToastDescriptor.md +29 -55
- package/docs/interfaces/ToastNotificationMeta.md +40 -69
- package/docs/interfaces/UploadedFile.md +25 -49
- package/docs/interfaces/UseConfigOptions.md +6 -12
- package/docs/interfaces/UsePatientPhotoResult.md +12 -24
- package/docs/interfaces/UseServerFetchAllOptions.md +41 -61
- package/docs/interfaces/UseServerInfiniteOptions.md +29 -46
- package/docs/interfaces/UseServerPaginationOptions.md +26 -41
- package/docs/interfaces/User.md +34 -46
- package/docs/interfaces/UserHasAccessProps.md +13 -25
- package/docs/interfaces/Visit.md +36 -66
- package/docs/interfaces/VisitItem.md +16 -31
- package/docs/interfaces/VisitReturnType.md +24 -51
- package/docs/interfaces/VisitStoreState.md +14 -26
- package/docs/interfaces/VisitType.md +11 -23
- package/docs/interfaces/WorkspaceContainerProps.md +20 -38
- package/docs/interfaces/WorkspaceGroupDefinition.md +10 -19
- package/docs/interfaces/WorkspaceRegistration.md +43 -82
- package/docs/interfaces/WorkspacesInfo.md +26 -40
- package/docs/type-aliases/ActionFunction.md +27 -0
- package/docs/type-aliases/ActionableNotificationType.md +7 -0
- package/docs/type-aliases/Actions.md +13 -0
- package/docs/type-aliases/ArgumentsTuple.md +7 -0
- package/docs/type-aliases/BoundActions.md +17 -0
- package/docs/type-aliases/ConfigValue.md +7 -0
- package/docs/type-aliases/ContextCallback.md +23 -0
- package/docs/type-aliases/CoreTranslationKey.md +7 -0
- package/docs/type-aliases/CurrentPatient.md +7 -0
- package/docs/type-aliases/DateInput.md +7 -0
- package/docs/type-aliases/DefaultEvaluateReturnType.md +9 -0
- package/docs/type-aliases/ExtensionDefinition.md +69 -0
- package/docs/type-aliases/ExtensionProps.md +13 -0
- package/docs/type-aliases/FormatDateMode.md +7 -0
- package/docs/type-aliases/FormatDateOptions.md +102 -0
- package/docs/type-aliases/IconProps.md +31 -0
- package/docs/type-aliases/InlineNotificationType.md +7 -0
- package/docs/type-aliases/Key.md +7 -0
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +7 -0
- package/docs/type-aliases/LayoutType.md +7 -0
- package/docs/type-aliases/LoadedSessionStore.md +23 -0
- package/docs/type-aliases/ModalDefinition.md +17 -0
- package/docs/type-aliases/NameUse.md +7 -0
- package/docs/type-aliases/NullablePatient.md +7 -0
- package/docs/type-aliases/OfflineMode.md +7 -0
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +12 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +7 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +44 -0
- package/docs/type-aliases/OpenmrsRoutes.md +10 -0
- package/docs/type-aliases/PageDefinition.md +41 -0
- package/docs/type-aliases/PageHeaderProps.md +7 -0
- package/docs/type-aliases/PatientUuid.md +7 -0
- package/docs/type-aliases/PictogramProps.md +23 -0
- package/docs/type-aliases/ProvidedConfig.md +23 -0
- package/docs/type-aliases/ResourceName.md +7 -0
- package/docs/type-aliases/SessionStore.md +7 -0
- package/docs/type-aliases/SnackbarType.md +7 -0
- package/docs/type-aliases/SpaEnvironment.md +7 -0
- package/docs/type-aliases/SvgIconProps.md +23 -0
- package/docs/type-aliases/SvgPictogramProps.md +27 -0
- package/docs/type-aliases/TemplateParams.md +11 -0
- package/docs/type-aliases/ToastType.md +7 -0
- package/docs/type-aliases/UnloadedSessionStore.md +23 -0
- package/docs/type-aliases/UpdateVisitPayload.md +7 -0
- package/docs/type-aliases/UseOpenmrsSWROptions.md +39 -0
- package/docs/type-aliases/Validator.md +17 -0
- package/docs/type-aliases/ValidatorFunction.md +17 -0
- package/docs/type-aliases/VariablesMap.md +13 -0
- package/docs/type-aliases/WorkspaceDefinition.md +78 -0
- package/docs/type-aliases/WorkspaceWindowState.md +7 -0
- package/docs/variables/ActionMenuButton.md +7 -0
- package/docs/variables/ActivityIcon.md +7 -0
- package/docs/variables/AddIcon.md +7 -0
- package/docs/variables/AllergiesIcon.md +7 -0
- package/docs/variables/AppointmentsPictogram.md +7 -0
- package/docs/variables/ArrowDownIcon.md +7 -0
- package/docs/variables/ArrowLeftIcon.md +7 -0
- package/docs/variables/ArrowRightIcon.md +7 -0
- package/docs/variables/ArrowUpIcon.md +7 -0
- package/docs/variables/AttachmentIcon.md +7 -0
- package/docs/variables/BabyIcon.md +7 -0
- package/docs/variables/CalendarHeatMapIcon.md +7 -0
- package/docs/variables/CalendarIcon.md +7 -0
- package/docs/variables/CaretDownIcon.md +7 -0
- package/docs/variables/CaretLeftIcon.md +7 -0
- package/docs/variables/CaretRightIcon.md +7 -0
- package/docs/variables/CaretUpIcon.md +7 -0
- package/docs/variables/ChartAverageIcon.md +7 -0
- package/docs/variables/CheckmarkFilledIcon.md +7 -0
- package/docs/variables/CheckmarkOutlineIcon.md +7 -0
- package/docs/variables/ChemistryIcon.md +7 -0
- package/docs/variables/ChevronDownIcon.md +7 -0
- package/docs/variables/ChevronLeftIcon.md +7 -0
- package/docs/variables/ChevronRightIcon.md +7 -0
- package/docs/variables/ChevronUpIcon.md +7 -0
- package/docs/variables/CloseFilledIcon.md +7 -0
- package/docs/variables/CloseIcon.md +7 -0
- package/docs/variables/CloseOutlineIcon.md +7 -0
- package/docs/variables/ConditionsIcon.md +11 -0
- package/docs/variables/DiagnosisTags.md +11 -0
- package/docs/variables/DocumentAttachmentIcon.md +7 -0
- package/docs/variables/DocumentIcon.md +7 -0
- package/docs/variables/DownloadIcon.md +7 -0
- package/docs/variables/DrugOrderIcon.md +7 -0
- package/docs/variables/EditIcon.md +7 -0
- package/docs/variables/ErrorState.md +7 -0
- package/docs/variables/EventScheduleIcon.md +7 -0
- package/docs/variables/EventsIcon.md +7 -0
- package/docs/variables/Extension.md +15 -0
- package/docs/variables/GenderFemaleIcon.md +7 -0
- package/docs/variables/GenderMaleIcon.md +7 -0
- package/docs/variables/GenderOtherIcon.md +7 -0
- package/docs/variables/GenderUnknownIcon.md +7 -0
- package/docs/variables/GenericOrderTypeIcon.md +7 -0
- package/docs/variables/GroupAccessIcon.md +7 -0
- package/docs/variables/GroupIcon.md +7 -0
- package/docs/variables/HomePictogram.md +7 -0
- package/docs/variables/HospitalBedIcon.md +7 -0
- package/docs/variables/Icon.md +9 -0
- package/docs/variables/ImageMedicalIcon.md +7 -0
- package/docs/variables/InPatientPictogram.md +7 -0
- package/docs/variables/InformationFilledIcon.md +7 -0
- package/docs/variables/InformationIcon.md +7 -0
- package/docs/variables/InformationSquareIcon.md +7 -0
- package/docs/variables/InventoryManagementIcon.md +7 -0
- package/docs/variables/LabOrderIcon.md +7 -0
- package/docs/variables/LaboratoryPictogram.md +7 -0
- package/docs/variables/LeftNavMenu.md +13 -0
- package/docs/variables/ListCheckedIcon.md +7 -0
- package/docs/variables/LocationIcon.md +7 -0
- package/docs/variables/LocationPicker.md +7 -0
- package/docs/variables/MaterialOrderIcon.md +7 -0
- package/docs/variables/MaximizeIcon.md +7 -0
- package/docs/variables/MaybeIcon.md +16 -0
- package/docs/variables/MaybePictogram.md +16 -0
- package/docs/variables/MedicationIcon.md +7 -0
- package/docs/variables/MessageQueueIcon.md +7 -0
- package/docs/variables/MicroscopeIcon.md +7 -0
- package/docs/variables/MoneyIcon.md +9 -0
- package/docs/variables/MotherIcon.md +7 -0
- package/docs/variables/MovementIcon.md +7 -0
- package/docs/variables/OpenmrsDatePicker.md +9 -0
- package/docs/variables/OverflowMenuHorizontalIcon.md +7 -0
- package/docs/variables/OverflowMenuVerticalIcon.md +7 -0
- package/docs/variables/PageHeader.md +30 -0
- package/docs/variables/PageHeaderContent.md +21 -0
- package/docs/variables/PasswordIcon.md +7 -0
- package/docs/variables/PatientListsPictogram.md +7 -0
- package/docs/variables/PedestrianFamilyIcon.md +7 -0
- package/docs/variables/PenIcon.md +7 -0
- package/docs/variables/PharmacyPictogram.md +7 -0
- package/docs/variables/Pictogram.md +9 -0
- package/docs/variables/PrinterIcon.md +7 -0
- package/docs/variables/ProcedureOrderIcon.md +7 -0
- package/docs/variables/ProgramsIcon.md +7 -0
- package/docs/variables/RadiologyIcon.md +7 -0
- package/docs/variables/ReferralOrderIcon.md +7 -0
- package/docs/variables/RegistrationPictogram.md +7 -0
- package/docs/variables/RenderIfValueIsTruthy.md +21 -0
- package/docs/variables/RenewIcon.md +7 -0
- package/docs/variables/ReportIcon.md +7 -0
- package/docs/variables/ResetIcon.md +7 -0
- package/docs/variables/ResponsiveWrapper.md +11 -0
- package/docs/variables/SaveIcon.md +7 -0
- package/docs/variables/SearchIcon.md +7 -0
- package/docs/variables/ServiceQueuesPictogram.md +7 -0
- package/docs/variables/ShoppingCartAddItemIcon.md +11 -0
- package/docs/variables/ShoppingCartArrowDownIcon.md +9 -0
- package/docs/variables/ShoppingCartIcon.md +9 -0
- package/docs/variables/StickyNoteAddIcon.md +9 -0
- package/docs/variables/StockManagementPictogram.md +7 -0
- package/docs/variables/SwitcherIcon.md +7 -0
- package/docs/variables/SyringeIcon.md +7 -0
- package/docs/variables/TableIcon.md +7 -0
- package/docs/variables/TableOfContentsIcon.md +9 -0
- package/docs/variables/TimeIcon.md +9 -0
- package/docs/variables/ToolsIcon.md +7 -0
- package/docs/variables/TranslateIcon.md +7 -0
- package/docs/variables/TrashCanIcon.md +7 -0
- package/docs/variables/TreeViewAltIcon.md +7 -0
- package/docs/variables/UserAvatarIcon.md +9 -0
- package/docs/variables/UserFollowIcon.md +7 -0
- package/docs/variables/UserHasAccess.md +35 -0
- package/docs/variables/UserIcon.md +7 -0
- package/docs/variables/UserXrayIcon.md +11 -0
- package/docs/variables/ViewIcon.md +7 -0
- package/docs/variables/ViewOffIcon.md +7 -0
- package/docs/variables/WarningIcon.md +7 -0
- package/docs/variables/attachmentUrl.md +7 -0
- package/docs/variables/backendDependencies.md +17 -0
- package/docs/variables/defaultVisitCustomRepresentation.md +7 -0
- package/docs/variables/fhirBaseUrl.md +7 -0
- package/docs/variables/getAsyncExtensionLifecycle.md +35 -0
- package/docs/variables/getStartedVisit.md +9 -0
- package/docs/variables/isUrl.md +9 -0
- package/docs/variables/offlineUuidPrefix.md +7 -0
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +7 -0
- package/docs/variables/restBaseUrl.md +7 -0
- package/docs/variables/sessionEndpoint.md +7 -0
- package/docs/variables/useConnectedExtensions.md +25 -0
- package/docs/variables/useExtensionStore.md +55 -0
- package/docs/variables/validators.md +78 -0
- package/package.json +24 -20
- package/rspack.config.cjs +1 -8
- package/tsconfig.build.json +2 -1
- package/typedoc.json +16 -4
- package/docs/.nojekyll +0 -1
- package/docs/enums/Type.md +0 -107
- package/docs/enums/VisitMode.md +0 -41
- package/docs/enums/VisitStatus.md +0 -30
- package/docs/interfaces/OldExtensionSlotBaseProps.md +0 -67
@@ -1,67 +1,51 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ConnectedExtension
|
2
2
|
|
3
|
-
# Interface: ConnectedExtension
|
3
|
+
# Interface: ~~ConnectedExtension~~
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/store.ts#L85)
|
6
6
|
|
7
|
-
##
|
7
|
+
## Deprecated
|
8
8
|
|
9
|
-
|
9
|
+
replaced with AssignedExtension
|
10
10
|
|
11
|
-
|
12
|
-
- [id](ConnectedExtension.md#id)
|
13
|
-
- [meta](ConnectedExtension.md#meta)
|
14
|
-
- [moduleName](ConnectedExtension.md#modulename)
|
15
|
-
- [name](ConnectedExtension.md#name)
|
11
|
+
## Properties
|
16
12
|
|
17
|
-
|
13
|
+
### ~~config~~
|
18
14
|
|
19
|
-
|
15
|
+
> `readonly` **config**: `null` \| `Readonly`\<`ConfigObject`\>
|
20
16
|
|
21
|
-
|
17
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/store.ts#L91)
|
22
18
|
|
23
19
|
The extension's config. Note that this will be `null` until the slot is mounted.
|
24
20
|
|
25
|
-
|
21
|
+
***
|
26
22
|
|
27
|
-
|
23
|
+
### ~~id~~
|
28
24
|
|
29
|
-
|
25
|
+
> `readonly` **id**: `string`
|
30
26
|
|
31
|
-
|
27
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/store.ts#L86)
|
32
28
|
|
33
|
-
|
29
|
+
***
|
34
30
|
|
35
|
-
|
31
|
+
### ~~meta~~
|
36
32
|
|
37
|
-
[
|
33
|
+
> `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
|
38
34
|
|
39
|
-
|
35
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/store.ts#L89)
|
40
36
|
|
41
|
-
|
37
|
+
***
|
42
38
|
|
43
|
-
|
39
|
+
### ~~moduleName~~
|
44
40
|
|
45
|
-
|
41
|
+
> `readonly` **moduleName**: `string`
|
46
42
|
|
47
|
-
[packages/framework/esm-extensions/src/store.ts:
|
43
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/store.ts#L88)
|
48
44
|
|
49
|
-
|
45
|
+
***
|
50
46
|
|
51
|
-
###
|
47
|
+
### ~~name~~
|
52
48
|
|
53
|
-
|
49
|
+
> `readonly` **name**: `string`
|
54
50
|
|
55
|
-
|
56
|
-
|
57
|
-
[packages/framework/esm-extensions/src/store.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L88)
|
58
|
-
|
59
|
-
___
|
60
|
-
|
61
|
-
### name
|
62
|
-
|
63
|
-
• `Readonly` **name**: `string`
|
64
|
-
|
65
|
-
#### Defined in
|
66
|
-
|
67
|
-
[packages/framework/esm-extensions/src/store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L87)
|
51
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/store.ts#L87)
|
@@ -1,19 +1,13 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ConnectivityChangedEvent
|
2
2
|
|
3
3
|
# Interface: ConnectivityChangedEvent
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
### Properties
|
8
|
-
|
9
|
-
- [online](ConnectivityChangedEvent.md#online)
|
5
|
+
Defined in: packages/framework/esm-globals/dist/events.d.ts:1
|
10
6
|
|
11
7
|
## Properties
|
12
8
|
|
13
9
|
### online
|
14
10
|
|
15
|
-
|
16
|
-
|
17
|
-
#### Defined in
|
11
|
+
> **online**: `boolean`
|
18
12
|
|
19
|
-
packages/framework/esm-globals/dist/events.d.ts:2
|
13
|
+
Defined in: packages/framework/esm-globals/dist/events.d.ts:2
|
@@ -1,27 +1,18 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / CurrentPatientOptions
|
2
2
|
|
3
3
|
# Interface: CurrentPatientOptions
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/current-patient.ts#L7)
|
6
6
|
|
7
|
-
|
7
|
+
## Extended by
|
8
8
|
|
9
|
-
|
9
|
+
- [`PatientWithFullResponse`](PatientWithFullResponse.md)
|
10
|
+
- [`OnlyThePatient`](OnlyThePatient.md)
|
10
11
|
|
11
|
-
|
12
|
+
## Properties
|
12
13
|
|
13
|
-
|
14
|
+
### includeConfig?
|
14
15
|
|
15
|
-
|
16
|
+
> `optional` **includeConfig**: `boolean`
|
16
17
|
|
17
|
-
|
18
|
-
|
19
|
-
## API Properties
|
20
|
-
|
21
|
-
### includeConfig
|
22
|
-
|
23
|
-
• `Optional` **includeConfig**: `boolean`
|
24
|
-
|
25
|
-
#### Defined in
|
26
|
-
|
27
|
-
[packages/framework/esm-emr-api/src/current-patient.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L8)
|
18
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/current-patient.ts#L8)
|
@@ -1,52 +1,37 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / DashboardExtensionProps
|
2
2
|
|
3
3
|
# Interface: DashboardExtensionProps
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
### Properties
|
8
|
-
|
9
|
-
- [basePath](DashboardExtensionProps.md#basepath)
|
10
|
-
- [icon](DashboardExtensionProps.md#icon)
|
11
|
-
- [path](DashboardExtensionProps.md#path)
|
12
|
-
- [title](DashboardExtensionProps.md#title)
|
5
|
+
Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L9)
|
13
6
|
|
14
7
|
## Properties
|
15
8
|
|
16
9
|
### basePath
|
17
10
|
|
18
|
-
|
19
|
-
|
20
|
-
#### Defined in
|
11
|
+
> **basePath**: `string`
|
21
12
|
|
22
|
-
[packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/
|
13
|
+
Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L12)
|
23
14
|
|
24
|
-
|
15
|
+
***
|
25
16
|
|
26
17
|
### icon
|
27
18
|
|
28
|
-
|
19
|
+
> **icon**: `string`
|
29
20
|
|
30
|
-
|
21
|
+
Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L13)
|
31
22
|
|
32
|
-
|
33
|
-
|
34
|
-
___
|
23
|
+
***
|
35
24
|
|
36
25
|
### path
|
37
26
|
|
38
|
-
|
39
|
-
|
40
|
-
#### Defined in
|
27
|
+
> **path**: `string`
|
41
28
|
|
42
|
-
[packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/
|
29
|
+
Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L10)
|
43
30
|
|
44
|
-
|
31
|
+
***
|
45
32
|
|
46
33
|
### title
|
47
34
|
|
48
|
-
|
49
|
-
|
50
|
-
#### Defined in
|
35
|
+
> **title**: `string`
|
51
36
|
|
52
|
-
[packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/
|
37
|
+
Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L11)
|
@@ -1,29 +1,22 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / DefaultWorkspaceProps
|
2
2
|
|
3
3
|
# Interface: DefaultWorkspaceProps
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
## Hierarchy
|
8
|
-
|
9
|
-
- **`DefaultWorkspaceProps`**
|
5
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L41)
|
10
6
|
|
11
|
-
|
12
|
-
|
13
|
-
## Table of contents
|
7
|
+
The default parameters received by all workspaces
|
14
8
|
|
15
|
-
|
9
|
+
## Extended by
|
16
10
|
|
17
|
-
- [
|
18
|
-
- [closeWorkspaceWithSavedChanges](DefaultWorkspaceProps.md#closeworkspacewithsavedchanges)
|
19
|
-
- [promptBeforeClosing](DefaultWorkspaceProps.md#promptbeforeclosing)
|
20
|
-
- [setTitle](DefaultWorkspaceProps.md#settitle)
|
11
|
+
- [`OpenWorkspace`](OpenWorkspace.md)
|
21
12
|
|
22
13
|
## Methods
|
23
14
|
|
24
|
-
### closeWorkspace
|
15
|
+
### closeWorkspace()
|
25
16
|
|
26
|
-
|
17
|
+
> **closeWorkspace**(`closeWorkspaceOptions?`): `void`
|
18
|
+
|
19
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L49)
|
27
20
|
|
28
21
|
Call this function to close the workspace. This function will prompt the user
|
29
22
|
if there are any unsaved changes to workspace.
|
@@ -33,69 +26,63 @@ closed, given the user forcefully closes the workspace.
|
|
33
26
|
|
34
27
|
#### Parameters
|
35
28
|
|
36
|
-
|
37
|
-
|
38
|
-
|
29
|
+
##### closeWorkspaceOptions?
|
30
|
+
|
31
|
+
[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
|
39
32
|
|
40
33
|
#### Returns
|
41
34
|
|
42
35
|
`void`
|
43
36
|
|
44
|
-
|
45
|
-
|
46
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L49)
|
37
|
+
***
|
47
38
|
|
48
|
-
|
39
|
+
### closeWorkspaceWithSavedChanges()
|
49
40
|
|
50
|
-
|
41
|
+
> **closeWorkspaceWithSavedChanges**(`closeWorkspaceOptions?`): `void`
|
51
42
|
|
52
|
-
|
43
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L59)
|
53
44
|
|
54
45
|
Call this function to close the workspace after the form is saved. This function
|
55
46
|
will directly close the workspace without any prompt
|
56
47
|
|
57
48
|
#### Parameters
|
58
49
|
|
59
|
-
|
60
|
-
|
61
|
-
|
50
|
+
##### closeWorkspaceOptions?
|
51
|
+
|
52
|
+
[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
|
62
53
|
|
63
54
|
#### Returns
|
64
55
|
|
65
56
|
`void`
|
66
57
|
|
67
|
-
|
68
|
-
|
69
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L59)
|
58
|
+
***
|
70
59
|
|
71
|
-
|
60
|
+
### promptBeforeClosing()
|
72
61
|
|
73
|
-
|
62
|
+
> **promptBeforeClosing**(`testFcn`): `void`
|
74
63
|
|
75
|
-
|
64
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L54)
|
76
65
|
|
77
66
|
Call this with a no-args function that returns true if the user should be prompted before
|
78
67
|
this workspace is closed; e.g. if there is unsaved data.
|
79
68
|
|
80
69
|
#### Parameters
|
81
70
|
|
82
|
-
|
83
|
-
|
84
|
-
|
71
|
+
##### testFcn
|
72
|
+
|
73
|
+
() => `boolean`
|
85
74
|
|
86
75
|
#### Returns
|
87
76
|
|
88
77
|
`void`
|
89
78
|
|
90
|
-
|
91
|
-
|
92
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L54)
|
79
|
+
***
|
93
80
|
|
94
|
-
|
81
|
+
### setTitle()
|
95
82
|
|
96
|
-
|
83
|
+
> **setTitle**(`title`, `titleNode?`): `void`
|
97
84
|
|
98
|
-
|
85
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L74)
|
99
86
|
|
100
87
|
Use this to set the workspace title if it needs to be set dynamically.
|
101
88
|
|
@@ -106,15 +93,21 @@ title needs to be set dynamically.
|
|
106
93
|
|
107
94
|
#### Parameters
|
108
95
|
|
109
|
-
|
110
|
-
| :------ | :------ | :------ |
|
111
|
-
| `title` | `string` | The title to set. If using titleNode, set this to a human-readable string which will identify the workspace in notifications and other places. |
|
112
|
-
| `titleNode?` | `ReactNode` | A React object to put in the workspace header in place of the title. This is useful for displaying custom elements in the header. Note that custom header elements can also be attached to the workspace header extension slots. |
|
96
|
+
##### title
|
113
97
|
|
114
|
-
|
98
|
+
`string`
|
115
99
|
|
116
|
-
|
100
|
+
The title to set. If using titleNode, set this to a human-readable string
|
101
|
+
which will identify the workspace in notifications and other places.
|
102
|
+
|
103
|
+
##### titleNode?
|
117
104
|
|
118
|
-
|
105
|
+
`ReactNode`
|
119
106
|
|
120
|
-
|
107
|
+
A React object to put in the workspace header in place of the title. This
|
108
|
+
is useful for displaying custom elements in the header. Note that custom header
|
109
|
+
elements can also be attached to the workspace header extension slots.
|
110
|
+
|
111
|
+
#### Returns
|
112
|
+
|
113
|
+
`void`
|
@@ -1,189 +1,165 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / Diagnosis
|
2
2
|
|
3
3
|
# Interface: Diagnosis
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L6)
|
6
6
|
|
7
|
-
|
8
|
-
|
9
|
-
↳ **`Diagnosis`**
|
7
|
+
## Extends
|
10
8
|
|
11
|
-
|
9
|
+
- `OpenmrsResource`
|
12
10
|
|
13
|
-
|
11
|
+
## Indexable
|
14
12
|
|
15
|
-
|
16
|
-
- [certainty](Diagnosis.md#certainty)
|
17
|
-
- [diagnosis](Diagnosis.md#diagnosis)
|
18
|
-
- [display](Diagnosis.md#display)
|
19
|
-
- [encounter](Diagnosis.md#encounter)
|
20
|
-
- [formFieldNamespace](Diagnosis.md#formfieldnamespace)
|
21
|
-
- [formFieldPath](Diagnosis.md#formfieldpath)
|
22
|
-
- [links](Diagnosis.md#links)
|
23
|
-
- [patient](Diagnosis.md#patient)
|
24
|
-
- [rank](Diagnosis.md#rank)
|
25
|
-
- [resourceVersion](Diagnosis.md#resourceversion)
|
26
|
-
- [uuid](Diagnosis.md#uuid)
|
27
|
-
- [voided](Diagnosis.md#voided)
|
13
|
+
\[`anythingElse`: `string`\]: `any`
|
28
14
|
|
29
15
|
## Properties
|
30
16
|
|
31
|
-
### auditInfo
|
17
|
+
### auditInfo?
|
18
|
+
|
19
|
+
> `optional` **auditInfo**: `AuditInfo`
|
32
20
|
|
33
|
-
|
21
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
|
34
22
|
|
35
23
|
#### Inherited from
|
36
24
|
|
37
|
-
OpenmrsResource.auditInfo
|
25
|
+
`OpenmrsResource.auditInfo`
|
38
26
|
|
39
|
-
|
27
|
+
***
|
40
28
|
|
41
|
-
|
29
|
+
### certainty?
|
42
30
|
|
43
|
-
|
31
|
+
> `optional` **certainty**: `string`
|
44
32
|
|
45
|
-
|
33
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L19)
|
46
34
|
|
47
|
-
|
35
|
+
***
|
48
36
|
|
49
|
-
|
37
|
+
### diagnosis?
|
50
38
|
|
51
|
-
|
39
|
+
> `optional` **diagnosis**: `object`
|
52
40
|
|
53
|
-
|
41
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L7)
|
54
42
|
|
55
|
-
|
43
|
+
#### coded?
|
56
44
|
|
57
|
-
|
45
|
+
> `optional` **coded**: `object`
|
58
46
|
|
59
|
-
|
47
|
+
##### coded.conceptClass?
|
60
48
|
|
61
|
-
|
62
|
-
| :------ | :------ |
|
63
|
-
| `coded?` | { `conceptClass?`: `ConceptClass` ; `datatype?`: `OpenmrsResource` ; `display?`: `string` ; `name?`: `Concept` ; `uuid`: `string` } |
|
64
|
-
| `coded.conceptClass?` | `ConceptClass` |
|
65
|
-
| `coded.datatype?` | `OpenmrsResource` |
|
66
|
-
| `coded.display?` | `string` |
|
67
|
-
| `coded.name?` | `Concept` |
|
68
|
-
| `coded.uuid` | `string` |
|
69
|
-
| `nonCoded?` | `string` |
|
49
|
+
> `optional` **conceptClass**: `ConceptClass`
|
70
50
|
|
71
|
-
|
51
|
+
##### coded.datatype?
|
72
52
|
|
73
|
-
|
53
|
+
> `optional` **datatype**: `OpenmrsResource`
|
74
54
|
|
75
|
-
|
55
|
+
##### coded.display?
|
76
56
|
|
77
|
-
|
57
|
+
> `optional` **display**: `string`
|
78
58
|
|
79
|
-
|
59
|
+
##### coded.name?
|
80
60
|
|
81
|
-
|
61
|
+
> `optional` **name**: `Concept`
|
82
62
|
|
83
|
-
|
63
|
+
##### coded.uuid
|
84
64
|
|
85
|
-
|
65
|
+
> **uuid**: `string`
|
86
66
|
|
87
|
-
|
67
|
+
#### nonCoded?
|
88
68
|
|
89
|
-
|
69
|
+
> `optional` **nonCoded**: `string`
|
90
70
|
|
91
|
-
|
71
|
+
***
|
92
72
|
|
93
|
-
|
73
|
+
### display?
|
94
74
|
|
95
|
-
|
75
|
+
> `optional` **display**: `string`
|
96
76
|
|
97
|
-
|
77
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
|
98
78
|
|
99
|
-
|
79
|
+
#### Inherited from
|
100
80
|
|
101
|
-
|
81
|
+
`OpenmrsResource.display`
|
102
82
|
|
103
|
-
|
83
|
+
***
|
104
84
|
|
105
|
-
|
85
|
+
### encounter?
|
106
86
|
|
107
|
-
[
|
87
|
+
> `optional` **encounter**: [`Encounter`](Encounter.md)
|
108
88
|
|
109
|
-
|
89
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L18)
|
110
90
|
|
111
|
-
|
91
|
+
***
|
112
92
|
|
113
|
-
|
93
|
+
### formFieldNamespace?
|
114
94
|
|
115
|
-
|
95
|
+
> `optional` **formFieldNamespace**: `string`
|
116
96
|
|
117
|
-
[packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:
|
97
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L21)
|
118
98
|
|
119
|
-
|
99
|
+
***
|
120
100
|
|
121
|
-
###
|
101
|
+
### formFieldPath?
|
122
102
|
|
123
|
-
|
103
|
+
> `optional` **formFieldPath**: `string`
|
124
104
|
|
125
|
-
|
105
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L22)
|
126
106
|
|
127
|
-
|
107
|
+
***
|
128
108
|
|
129
|
-
|
109
|
+
### links?
|
130
110
|
|
131
|
-
|
111
|
+
> `optional` **links**: `Link`[]
|
132
112
|
|
133
|
-
|
113
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
|
134
114
|
|
135
|
-
|
115
|
+
#### Inherited from
|
136
116
|
|
137
|
-
|
117
|
+
`OpenmrsResource.links`
|
138
118
|
|
139
|
-
|
119
|
+
***
|
140
120
|
|
141
|
-
|
121
|
+
### patient?
|
142
122
|
|
143
|
-
|
123
|
+
> `optional` **patient**: [`Patient`](Patient.md)
|
144
124
|
|
145
|
-
|
125
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L17)
|
146
126
|
|
147
|
-
|
127
|
+
***
|
148
128
|
|
149
|
-
|
129
|
+
### rank?
|
150
130
|
|
151
|
-
|
131
|
+
> `optional` **rank**: `number`
|
152
132
|
|
153
|
-
|
133
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L20)
|
154
134
|
|
155
|
-
|
135
|
+
***
|
156
136
|
|
157
|
-
|
137
|
+
### resourceVersion?
|
158
138
|
|
159
|
-
|
139
|
+
> `optional` **resourceVersion**: `string`
|
160
140
|
|
161
|
-
|
141
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
|
162
142
|
|
163
|
-
####
|
143
|
+
#### Inherited from
|
164
144
|
|
165
|
-
|
145
|
+
`OpenmrsResource.resourceVersion`
|
166
146
|
|
167
|
-
|
147
|
+
***
|
168
148
|
|
169
149
|
### uuid
|
170
150
|
|
171
|
-
|
151
|
+
> **uuid**: `string`
|
172
152
|
|
173
|
-
|
153
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
|
174
154
|
|
175
|
-
|
176
|
-
|
177
|
-
#### Defined in
|
178
|
-
|
179
|
-
packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
|
155
|
+
#### Inherited from
|
180
156
|
|
181
|
-
|
157
|
+
`OpenmrsResource.uuid`
|
182
158
|
|
183
|
-
|
159
|
+
***
|
184
160
|
|
185
|
-
|
161
|
+
### voided?
|
186
162
|
|
187
|
-
|
163
|
+
> `optional` **voided**: `boolean`
|
188
164
|
|
189
|
-
[packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/
|
165
|
+
Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L23)
|