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