@openmrs/esm-framework 6.3.1-pre.3106 → 6.3.1-pre.3124

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.
Files changed (542) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/dist/openmrs-esm-framework.js +2 -2
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +310 -8579
  5. package/docs/classes/OpenmrsFetchError.md +88 -117
  6. package/docs/enumerations/Type.md +77 -0
  7. package/docs/enumerations/VisitMode.md +29 -0
  8. package/docs/enumerations/VisitStatus.md +21 -0
  9. package/docs/functions/ConfigurableLink.md +19 -0
  10. package/docs/functions/CustomOverflowMenu.md +17 -0
  11. package/docs/functions/DashboardExtension.md +17 -0
  12. package/docs/functions/ExtensionSlot.md +46 -0
  13. package/docs/functions/OpenmrsAppContext.md +36 -0
  14. package/docs/functions/PatientBannerActionsMenu.md +17 -0
  15. package/docs/functions/PatientBannerContactDetails.md +17 -0
  16. package/docs/functions/PatientBannerPatientIdentifiers.md +17 -0
  17. package/docs/functions/PatientBannerPatientInfo.md +17 -0
  18. package/docs/functions/PatientBannerToggleContactDetailsButton.md +17 -0
  19. package/docs/functions/PatientPhoto.md +19 -0
  20. package/docs/functions/WorkspaceContainer.md +55 -0
  21. package/docs/functions/age.md +32 -0
  22. package/docs/functions/attach.md +40 -0
  23. package/docs/functions/beginEditSynchronizationItem.md +22 -0
  24. package/docs/functions/canAccessStorage.md +25 -0
  25. package/docs/functions/canBeginEditSynchronizationItemsOfType.md +22 -0
  26. package/docs/functions/clearCurrentUser.md +11 -0
  27. package/docs/functions/closeWorkspace.md +27 -0
  28. package/docs/functions/compile.md +30 -0
  29. package/docs/functions/convertToLocaleCalendar.md +25 -0
  30. package/docs/functions/createAttachment.md +21 -0
  31. package/docs/functions/createErrorHandler.md +21 -0
  32. package/docs/functions/createGlobalStore.md +36 -0
  33. package/docs/functions/createUseStore.md +66 -0
  34. package/docs/functions/defineConfigSchema.md +33 -0
  35. package/docs/functions/defineExtensionConfigSchema.md +38 -0
  36. package/docs/functions/deleteAttachmentPermanently.md +21 -0
  37. package/docs/functions/deleteSynchronizationItem.md +21 -0
  38. package/docs/functions/detach.md +25 -0
  39. package/docs/functions/detachAll.md +21 -0
  40. package/docs/functions/dispatchNotificationShown.md +17 -0
  41. package/docs/functions/dispatchPrecacheStaticDependencies.md +17 -0
  42. package/docs/functions/displayName.md +21 -0
  43. package/docs/functions/evaluate.md +84 -0
  44. package/docs/functions/evaluateAsBoolean.md +31 -0
  45. package/docs/functions/evaluateAsBooleanAsync.md +31 -0
  46. package/docs/functions/evaluateAsNumber.md +31 -0
  47. package/docs/functions/evaluateAsNumberAsync.md +31 -0
  48. package/docs/functions/evaluateAsType.md +46 -0
  49. package/docs/functions/evaluateAsTypeAsync.md +46 -0
  50. package/docs/functions/evaluateAsync.md +87 -0
  51. package/docs/functions/extractVariableNames.md +50 -0
  52. package/docs/functions/fetchCurrentPatient.md +25 -0
  53. package/docs/functions/filterBreadcrumbs.md +21 -0
  54. package/docs/functions/formatDate.md +39 -0
  55. package/docs/functions/formatDatetime.md +29 -0
  56. package/docs/functions/formatPartialDate.md +39 -0
  57. package/docs/functions/formatPatientName.md +23 -0
  58. package/docs/functions/formatTime.md +20 -0
  59. package/docs/functions/formattedName.md +21 -0
  60. package/docs/functions/generateOfflineUuid.md +13 -0
  61. package/docs/functions/getAssignedExtensions.md +23 -0
  62. package/docs/functions/getAsyncLifecycle.md +31 -0
  63. package/docs/functions/getAttachmentByUuid.md +21 -0
  64. package/docs/functions/getAttachments.md +25 -0
  65. package/docs/functions/getBreadcrumbs.md +11 -0
  66. package/docs/functions/getBreadcrumbsFor.md +17 -0
  67. package/docs/functions/getConfig.md +31 -0
  68. package/docs/functions/getContext.md +29 -0
  69. package/docs/functions/getCoreTranslation.md +35 -0
  70. package/docs/functions/getCurrentOfflineMode.md +11 -0
  71. package/docs/functions/getCurrentUser.md +154 -0
  72. package/docs/functions/getDefaultCalendar.md +21 -0
  73. package/docs/functions/getDefaultsFromConfigSchema.md +32 -0
  74. package/docs/functions/getDynamicOfflineDataEntries.md +28 -0
  75. package/docs/functions/getDynamicOfflineDataEntriesFor.md +34 -0
  76. package/docs/functions/getDynamicOfflineDataHandlers.md +13 -0
  77. package/docs/functions/getExtensionNameFromId.md +30 -0
  78. package/docs/functions/getExtensionStore.md +14 -0
  79. package/docs/functions/getFeatureFlag.md +21 -0
  80. package/docs/functions/getFhirServerPaginationHandlers.md +17 -0
  81. package/docs/functions/getFullSynchronizationItems.md +27 -0
  82. package/docs/functions/getFullSynchronizationItemsFor.md +33 -0
  83. package/docs/functions/getGlobalStore.md +36 -0
  84. package/docs/functions/getHistory.md +13 -0
  85. package/docs/functions/getLifecycle.md +27 -0
  86. package/docs/functions/getLocale.md +15 -0
  87. package/docs/functions/getLocations.md +21 -0
  88. package/docs/functions/getLoggedInUser.md +11 -0
  89. package/docs/functions/getOfflinePatientDataStore.md +15 -0
  90. package/docs/functions/getPatientName.md +26 -0
  91. package/docs/functions/getSessionLocation.md +11 -0
  92. package/docs/functions/getSessionStore.md +11 -0
  93. package/docs/functions/getSyncLifecycle.md +31 -0
  94. package/docs/functions/getSynchronizationItem.md +27 -0
  95. package/docs/functions/getSynchronizationItems.md +27 -0
  96. package/docs/functions/getVisitStore.md +11 -0
  97. package/docs/functions/getVisitTypes.md +11 -0
  98. package/docs/functions/getVisitsForPatient.md +29 -0
  99. package/docs/functions/goBackInHistory.md +25 -0
  100. package/docs/functions/importDynamic.md +58 -0
  101. package/docs/functions/inRange.md +27 -0
  102. package/docs/functions/interpolateString.md +34 -0
  103. package/docs/functions/interpolateUrl.md +48 -0
  104. package/docs/functions/isDesktop.md +17 -0
  105. package/docs/functions/isDevEnabled.md +11 -0
  106. package/docs/functions/isOfflineUuid.md +19 -0
  107. package/docs/functions/isOmrsDateStrict.md +20 -0
  108. package/docs/functions/isOmrsDateToday.md +19 -0
  109. package/docs/functions/isOnline.md +17 -0
  110. package/docs/functions/isUrlWithTemplateParameters.md +22 -0
  111. package/docs/functions/isVersionSatisfied.md +21 -0
  112. package/docs/functions/launchWorkspace.md +56 -0
  113. package/docs/functions/launchWorkspaceGroup.md +38 -0
  114. package/docs/functions/makeUrl.md +26 -0
  115. package/docs/functions/messageOmrsServiceWorker.md +23 -0
  116. package/docs/functions/navigate.md +48 -0
  117. package/docs/functions/navigateAndLaunchWorkspace.md +33 -0
  118. package/docs/functions/oneOf.md +21 -0
  119. package/docs/functions/openmrsFetch.md +75 -0
  120. package/docs/functions/openmrsObservableFetch.md +55 -0
  121. package/docs/functions/parseDate.md +20 -0
  122. package/docs/functions/provide.md +21 -0
  123. package/docs/functions/putDynamicOfflineData.md +28 -0
  124. package/docs/functions/putDynamicOfflineDataFor.md +34 -0
  125. package/docs/functions/queueSynchronizationItem.md +39 -0
  126. package/docs/functions/refetchCurrentUser.md +33 -0
  127. package/docs/functions/registerBreadcrumb.md +17 -0
  128. package/docs/functions/registerBreadcrumbs.md +17 -0
  129. package/docs/functions/registerContext.md +34 -0
  130. package/docs/functions/registerDefaultCalendar.md +33 -0
  131. package/docs/functions/registerFeatureFlag.md +36 -0
  132. package/docs/functions/registerOfflinePatientHandler.md +25 -0
  133. package/docs/functions/removeDynamicOfflineData.md +28 -0
  134. package/docs/functions/removeDynamicOfflineDataFor.md +34 -0
  135. package/docs/functions/renderExtension.md +41 -0
  136. package/docs/functions/reportError.md +17 -0
  137. package/docs/functions/retry.md +44 -0
  138. package/docs/functions/saveVisit.md +21 -0
  139. package/docs/functions/selectPreferredName.md +46 -0
  140. package/docs/functions/setCurrentVisit.md +21 -0
  141. package/docs/functions/setLeftNav.md +23 -0
  142. package/docs/functions/setSessionLocation.md +21 -0
  143. package/docs/functions/setUserLanguage.md +17 -0
  144. package/docs/functions/setUserProperties.md +23 -0
  145. package/docs/functions/setupDynamicOfflineDataHandler.md +22 -0
  146. package/docs/functions/setupOfflineSync.md +49 -0
  147. package/docs/functions/shallowEqual.md +32 -0
  148. package/docs/functions/showActionableNotification.md +21 -0
  149. package/docs/functions/showModal.md +44 -0
  150. package/docs/functions/showNotification.md +21 -0
  151. package/docs/functions/showSnackbar.md +21 -0
  152. package/docs/functions/showToast.md +21 -0
  153. package/docs/functions/subscribeActionableNotificationShown.md +21 -0
  154. package/docs/functions/subscribeConnectivity.md +21 -0
  155. package/docs/functions/subscribeConnectivityChanged.md +21 -0
  156. package/docs/functions/subscribeNotificationShown.md +21 -0
  157. package/docs/functions/subscribePrecacheStaticDependencies.md +21 -0
  158. package/docs/functions/subscribeSnackbarShown.md +21 -0
  159. package/docs/functions/subscribeTo.md +75 -0
  160. package/docs/functions/subscribeToContext.md +39 -0
  161. package/docs/functions/subscribeToastShown.md +21 -0
  162. package/docs/functions/syncAllDynamicOfflineData.md +27 -0
  163. package/docs/functions/syncDynamicOfflineData.md +33 -0
  164. package/docs/functions/syncOfflinePatientData.md +21 -0
  165. package/docs/functions/toDateObjectStrict.md +20 -0
  166. package/docs/functions/toLocationObject.md +17 -0
  167. package/docs/functions/toOmrsIsoString.md +23 -0
  168. package/docs/functions/toVisitTypeObject.md +17 -0
  169. package/docs/functions/translateFrom.md +55 -0
  170. package/docs/functions/unregisterContext.md +20 -0
  171. package/docs/functions/unsetLeftNav.md +23 -0
  172. package/docs/functions/updateContext.md +29 -0
  173. package/docs/functions/updateVisit.md +25 -0
  174. package/docs/functions/useAbortController.md +32 -0
  175. package/docs/functions/useAppContext.md +43 -0
  176. package/docs/functions/useAssignedExtensionIds.md +26 -0
  177. package/docs/functions/useAssignedExtensions.md +21 -0
  178. package/docs/functions/useAttachments.md +41 -0
  179. package/docs/functions/useBodyScrollLock.md +17 -0
  180. package/docs/functions/useConfig.md +27 -0
  181. package/docs/functions/useConnectivity.md +11 -0
  182. package/docs/functions/useDebounce.md +57 -0
  183. package/docs/functions/useDefineAppContext.md +70 -0
  184. package/docs/functions/useEmrConfiguration.md +35 -0
  185. package/docs/functions/useExtensionSlotMeta.md +25 -0
  186. package/docs/functions/useExtensionSlotStore.md +17 -0
  187. package/docs/functions/useFeatureFlag.md +30 -0
  188. package/docs/functions/useFhirFetchAll.md +44 -0
  189. package/docs/functions/useFhirInfinite.md +46 -0
  190. package/docs/functions/useFhirPagination.md +129 -0
  191. package/docs/functions/useLayoutType.md +11 -0
  192. package/docs/functions/useLeftNav.md +17 -0
  193. package/docs/functions/useLeftNavStore.md +11 -0
  194. package/docs/functions/useLocations.md +21 -0
  195. package/docs/functions/useOnClickOutside.md +27 -0
  196. package/docs/functions/useOnVisible.md +28 -0
  197. package/docs/functions/useOpenmrsFetchAll.md +46 -0
  198. package/docs/functions/useOpenmrsInfinite.md +54 -0
  199. package/docs/functions/useOpenmrsPagination.md +140 -0
  200. package/docs/functions/useOpenmrsSWR.md +71 -0
  201. package/docs/functions/usePagination.md +89 -0
  202. package/docs/functions/usePatient.md +38 -0
  203. package/docs/functions/usePatientPhoto.md +17 -0
  204. package/docs/functions/usePrimaryIdentifierCode.md +23 -0
  205. package/docs/functions/useRenderableExtensions.md +43 -0
  206. package/docs/functions/useSession.md +19 -0
  207. package/docs/functions/useStore.md +131 -0
  208. package/docs/functions/useStoreWithActions.md +33 -0
  209. package/docs/functions/useVisit.md +41 -0
  210. package/docs/functions/useVisitContextStore.md +23 -0
  211. package/docs/functions/useVisitTypes.md +11 -0
  212. package/docs/functions/useWorkspaces.md +11 -0
  213. package/docs/functions/userHasAccess.md +27 -0
  214. package/docs/functions/validator.md +44 -0
  215. package/docs/interfaces/ActionMenuButtonProps.md +33 -57
  216. package/docs/interfaces/ActionableNotificationDescriptor.md +32 -62
  217. package/docs/interfaces/AssignedExtension.md +30 -57
  218. package/docs/interfaces/Attachment.md +23 -47
  219. package/docs/interfaces/AttachmentResponse.md +20 -41
  220. package/docs/interfaces/AuditInfo.md +49 -88
  221. package/docs/interfaces/BreadcrumbRegistration.md +8 -17
  222. package/docs/interfaces/BreadcrumbSettings.md +18 -33
  223. package/docs/interfaces/CancelLoading.md +6 -10
  224. package/docs/interfaces/ClearDynamicRoutesMessage.md +9 -17
  225. package/docs/interfaces/CloseWorkspaceOptions.md +18 -29
  226. package/docs/interfaces/ComponentConfig.md +11 -23
  227. package/docs/interfaces/Concept.md +83 -131
  228. package/docs/interfaces/ConceptClass.md +46 -67
  229. package/docs/interfaces/ConceptDatatype.md +50 -74
  230. package/docs/interfaces/ConceptName.md +50 -74
  231. package/docs/interfaces/Config.md +4 -2
  232. package/docs/interfaces/ConfigObject.md +12 -21
  233. package/docs/interfaces/ConfigSchema.md +15 -27
  234. package/docs/interfaces/ConfigurableLinkProps.md +24 -4314
  235. package/docs/interfaces/ConnectedExtension.md +25 -41
  236. package/docs/interfaces/ConnectivityChangedEvent.md +4 -10
  237. package/docs/interfaces/CurrentPatientOptions.md +9 -18
  238. package/docs/interfaces/DashboardExtensionProps.md +13 -28
  239. package/docs/interfaces/DefaultWorkspaceProps.md +44 -51
  240. package/docs/interfaces/Diagnosis.md +80 -104
  241. package/docs/interfaces/DisplayConditionsConfigObject.md +18 -33
  242. package/docs/interfaces/DynamicOfflineData.md +23 -41
  243. package/docs/interfaces/DynamicOfflineDataHandler.md +47 -54
  244. package/docs/interfaces/DynamicOfflineDataSyncState.md +29 -39
  245. package/docs/interfaces/EmrApiConfigurationResponse.md +243 -350
  246. package/docs/interfaces/Encounter.md +67 -110
  247. package/docs/interfaces/EncounterProvider.md +39 -61
  248. package/docs/interfaces/EncounterRole.md +43 -68
  249. package/docs/interfaces/EncounterType.md +43 -68
  250. package/docs/interfaces/ErrorStateProps.md +7 -16
  251. package/docs/interfaces/ExtensionData.md +10 -22
  252. package/docs/interfaces/ExtensionMeta.md +4 -2
  253. package/docs/interfaces/ExtensionRegistration.md +36 -69
  254. package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
  255. package/docs/interfaces/ExtensionSlotConfig.md +20 -29
  256. package/docs/interfaces/ExtensionSlotConfigureValueObject.md +4 -2
  257. package/docs/interfaces/ExtensionSlotProps.md +3520 -0
  258. package/docs/interfaces/ExtensionSlotState.md +9 -18
  259. package/docs/interfaces/ExtensionStore.md +5 -11
  260. package/docs/interfaces/FHIRCode.md +11 -23
  261. package/docs/interfaces/FHIRLocationResource.md +25 -18
  262. package/docs/interfaces/FHIRResource.md +105 -41
  263. package/docs/interfaces/FeatureFlagDefinition.md +14 -26
  264. package/docs/interfaces/FetchConfig.md +80 -117
  265. package/docs/interfaces/FetchError.md +8 -21
  266. package/docs/interfaces/FetchHeaders.md +4 -2
  267. package/docs/interfaces/FetchResponse.md +124 -130
  268. package/docs/interfaces/FetchResponseJson.md +4 -2
  269. package/docs/interfaces/ImportMap.md +4 -10
  270. package/docs/interfaces/LeftNavStore.md +14 -29
  271. package/docs/interfaces/Link.md +11 -23
  272. package/docs/interfaces/Location.md +147 -250
  273. package/docs/interfaces/LoggedInUser.md +68 -70
  274. package/docs/interfaces/LoggedInUserFetchResponse.md +120 -128
  275. package/docs/interfaces/MessageServiceWorkerResult.md +17 -29
  276. package/docs/interfaces/NavigateOptions.md +9 -18
  277. package/docs/interfaces/NewVisitPayload.md +32 -48
  278. package/docs/interfaces/NotificationDescriptor.md +31 -58
  279. package/docs/interfaces/Obs.md +99 -166
  280. package/docs/interfaces/OfflineModeResult.md +11 -23
  281. package/docs/interfaces/OfflinePatientArgs.md +13 -20
  282. package/docs/interfaces/OfflinePatientDataSyncHandler.md +17 -27
  283. package/docs/interfaces/OfflinePatientDataSyncState.md +29 -51
  284. package/docs/interfaces/OfflinePatientDataSyncStore.md +13 -20
  285. package/docs/interfaces/OmrsServiceWorkerMessage.md +13 -23
  286. package/docs/interfaces/OnImportMapChangedMessage.md +12 -23
  287. package/docs/interfaces/OnlyThePatient.md +9 -17
  288. package/docs/interfaces/OpenWorkspace.md +116 -170
  289. package/docs/interfaces/OpenmrsAppContextProps.md +14 -23
  290. package/docs/interfaces/OpenmrsAppRoutes.md +41 -71
  291. package/docs/interfaces/OpenmrsDatePickerProps.md +346 -483
  292. package/docs/interfaces/OpenmrsResource.md +39 -57
  293. package/docs/interfaces/OpenmrsResourceStrict.md +27 -51
  294. package/docs/interfaces/PageHeaderContentProps.md +12 -24
  295. package/docs/interfaces/PageHeaderWrapperProps.md +9 -18
  296. package/docs/interfaces/Patient.md +41 -70
  297. package/docs/interfaces/PatientBannerActionsMenuProps.md +15 -30
  298. package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +17 -32
  299. package/docs/interfaces/PatientIdentifier.md +49 -84
  300. package/docs/interfaces/PatientIdentifierType.md +65 -112
  301. package/docs/interfaces/PatientPhotoProps.md +8 -17
  302. package/docs/interfaces/PatientWithFullResponse.md +9 -17
  303. package/docs/interfaces/Person.md +96 -160
  304. package/docs/interfaces/PersonAddress.md +136 -230
  305. package/docs/interfaces/PersonAttribute.md +43 -68
  306. package/docs/interfaces/PersonName.md +72 -118
  307. package/docs/interfaces/PrecacheStaticDependenciesEvent.md +3 -1
  308. package/docs/interfaces/PrimaryIdentifier.md +5 -11
  309. package/docs/interfaces/Privilege.md +11 -23
  310. package/docs/interfaces/Prompt.md +20 -41
  311. package/docs/interfaces/QueueItemDescriptor.md +23 -30
  312. package/docs/interfaces/RegisterDynamicRouteMessage.md +21 -38
  313. package/docs/interfaces/ResourceLoader.md +10 -14
  314. package/docs/interfaces/ResponsiveWrapperProps.md +5 -11
  315. package/docs/interfaces/RetryOptions.md +36 -37
  316. package/docs/interfaces/Role.md +10 -22
  317. package/docs/interfaces/Session.md +31 -54
  318. package/docs/interfaces/SessionLocation.md +10 -22
  319. package/docs/interfaces/SetLeftNavParams.md +15 -30
  320. package/docs/interfaces/ShowActionableNotificationEvent.md +26 -50
  321. package/docs/interfaces/ShowNotificationEvent.md +20 -38
  322. package/docs/interfaces/ShowSnackbarEvent.md +34 -64
  323. package/docs/interfaces/ShowToastEvent.md +22 -43
  324. package/docs/interfaces/SnackbarDescriptor.md +41 -76
  325. package/docs/interfaces/SnackbarMeta.md +55 -93
  326. package/docs/interfaces/SpaConfig.md +30 -40
  327. package/docs/interfaces/StyleguideConfigObject.md +39 -70
  328. package/docs/interfaces/SyncItem.md +34 -57
  329. package/docs/interfaces/SyncProcessOptions.md +22 -40
  330. package/docs/interfaces/ToastDescriptor.md +29 -55
  331. package/docs/interfaces/ToastNotificationMeta.md +40 -69
  332. package/docs/interfaces/UploadedFile.md +25 -49
  333. package/docs/interfaces/UseConfigOptions.md +6 -12
  334. package/docs/interfaces/UsePatientPhotoResult.md +12 -24
  335. package/docs/interfaces/UseServerFetchAllOptions.md +41 -61
  336. package/docs/interfaces/UseServerInfiniteOptions.md +29 -46
  337. package/docs/interfaces/UseServerPaginationOptions.md +26 -41
  338. package/docs/interfaces/User.md +34 -46
  339. package/docs/interfaces/UserHasAccessProps.md +13 -25
  340. package/docs/interfaces/Visit.md +36 -66
  341. package/docs/interfaces/VisitItem.md +16 -31
  342. package/docs/interfaces/VisitReturnType.md +24 -51
  343. package/docs/interfaces/VisitStoreState.md +14 -26
  344. package/docs/interfaces/VisitType.md +11 -23
  345. package/docs/interfaces/WorkspaceContainerProps.md +20 -38
  346. package/docs/interfaces/WorkspaceGroupDefinition.md +10 -19
  347. package/docs/interfaces/WorkspaceRegistration.md +43 -82
  348. package/docs/interfaces/WorkspacesInfo.md +30 -40
  349. package/docs/type-aliases/ActionFunction.md +27 -0
  350. package/docs/type-aliases/ActionableNotificationType.md +7 -0
  351. package/docs/type-aliases/Actions.md +13 -0
  352. package/docs/type-aliases/ArgumentsTuple.md +7 -0
  353. package/docs/type-aliases/BoundActions.md +17 -0
  354. package/docs/type-aliases/ConfigValue.md +7 -0
  355. package/docs/type-aliases/ContextCallback.md +23 -0
  356. package/docs/type-aliases/CoreTranslationKey.md +7 -0
  357. package/docs/type-aliases/CurrentPatient.md +7 -0
  358. package/docs/type-aliases/DateInput.md +7 -0
  359. package/docs/type-aliases/DefaultEvaluateReturnType.md +9 -0
  360. package/docs/type-aliases/ExtensionDefinition.md +69 -0
  361. package/docs/type-aliases/ExtensionProps.md +13 -0
  362. package/docs/type-aliases/FormatDateMode.md +7 -0
  363. package/docs/type-aliases/FormatDateOptions.md +102 -0
  364. package/docs/type-aliases/IconProps.md +31 -0
  365. package/docs/type-aliases/InlineNotificationType.md +7 -0
  366. package/docs/type-aliases/Key.md +7 -0
  367. package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +7 -0
  368. package/docs/type-aliases/LayoutType.md +7 -0
  369. package/docs/type-aliases/LoadedSessionStore.md +23 -0
  370. package/docs/type-aliases/ModalDefinition.md +17 -0
  371. package/docs/type-aliases/NameUse.md +7 -0
  372. package/docs/type-aliases/NullablePatient.md +7 -0
  373. package/docs/type-aliases/OfflineMode.md +7 -0
  374. package/docs/type-aliases/OmrsOfflineCachingStrategy.md +12 -0
  375. package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +7 -0
  376. package/docs/type-aliases/OmrsOfflineHttpHeaders.md +44 -0
  377. package/docs/type-aliases/OpenmrsRoutes.md +10 -0
  378. package/docs/type-aliases/PageDefinition.md +41 -0
  379. package/docs/type-aliases/PageHeaderProps.md +7 -0
  380. package/docs/type-aliases/PatientUuid.md +7 -0
  381. package/docs/type-aliases/PictogramProps.md +23 -0
  382. package/docs/type-aliases/ProvidedConfig.md +23 -0
  383. package/docs/type-aliases/ResourceName.md +7 -0
  384. package/docs/type-aliases/SessionStore.md +7 -0
  385. package/docs/type-aliases/SnackbarType.md +7 -0
  386. package/docs/type-aliases/SpaEnvironment.md +7 -0
  387. package/docs/type-aliases/SvgIconProps.md +23 -0
  388. package/docs/type-aliases/SvgPictogramProps.md +27 -0
  389. package/docs/type-aliases/TemplateParams.md +11 -0
  390. package/docs/type-aliases/ToastType.md +7 -0
  391. package/docs/type-aliases/UnloadedSessionStore.md +23 -0
  392. package/docs/type-aliases/UpdateVisitPayload.md +7 -0
  393. package/docs/type-aliases/UseOpenmrsSWROptions.md +39 -0
  394. package/docs/type-aliases/Validator.md +17 -0
  395. package/docs/type-aliases/ValidatorFunction.md +17 -0
  396. package/docs/type-aliases/VariablesMap.md +13 -0
  397. package/docs/type-aliases/WorkspaceDefinition.md +78 -0
  398. package/docs/type-aliases/WorkspaceWindowState.md +7 -0
  399. package/docs/variables/ActionMenuButton.md +7 -0
  400. package/docs/variables/ActivityIcon.md +7 -0
  401. package/docs/variables/AddIcon.md +7 -0
  402. package/docs/variables/AllergiesIcon.md +7 -0
  403. package/docs/variables/AppointmentsPictogram.md +7 -0
  404. package/docs/variables/ArrowDownIcon.md +7 -0
  405. package/docs/variables/ArrowLeftIcon.md +7 -0
  406. package/docs/variables/ArrowRightIcon.md +7 -0
  407. package/docs/variables/ArrowUpIcon.md +7 -0
  408. package/docs/variables/AttachmentIcon.md +7 -0
  409. package/docs/variables/BabyIcon.md +7 -0
  410. package/docs/variables/CalendarHeatMapIcon.md +7 -0
  411. package/docs/variables/CalendarIcon.md +7 -0
  412. package/docs/variables/CaretDownIcon.md +7 -0
  413. package/docs/variables/CaretLeftIcon.md +7 -0
  414. package/docs/variables/CaretRightIcon.md +7 -0
  415. package/docs/variables/CaretUpIcon.md +7 -0
  416. package/docs/variables/ChartAverageIcon.md +7 -0
  417. package/docs/variables/CheckmarkFilledIcon.md +7 -0
  418. package/docs/variables/CheckmarkOutlineIcon.md +7 -0
  419. package/docs/variables/ChemistryIcon.md +7 -0
  420. package/docs/variables/ChevronDownIcon.md +7 -0
  421. package/docs/variables/ChevronLeftIcon.md +7 -0
  422. package/docs/variables/ChevronRightIcon.md +7 -0
  423. package/docs/variables/ChevronUpIcon.md +7 -0
  424. package/docs/variables/CloseFilledIcon.md +7 -0
  425. package/docs/variables/CloseIcon.md +7 -0
  426. package/docs/variables/CloseOutlineIcon.md +7 -0
  427. package/docs/variables/ConditionsIcon.md +11 -0
  428. package/docs/variables/DiagnosisTags.md +11 -0
  429. package/docs/variables/DocumentAttachmentIcon.md +7 -0
  430. package/docs/variables/DocumentIcon.md +7 -0
  431. package/docs/variables/DownloadIcon.md +7 -0
  432. package/docs/variables/DrugOrderIcon.md +7 -0
  433. package/docs/variables/EditIcon.md +7 -0
  434. package/docs/variables/ErrorState.md +7 -0
  435. package/docs/variables/EventScheduleIcon.md +7 -0
  436. package/docs/variables/EventsIcon.md +7 -0
  437. package/docs/variables/Extension.md +15 -0
  438. package/docs/variables/GenderFemaleIcon.md +7 -0
  439. package/docs/variables/GenderMaleIcon.md +7 -0
  440. package/docs/variables/GenderOtherIcon.md +7 -0
  441. package/docs/variables/GenderUnknownIcon.md +7 -0
  442. package/docs/variables/GenericOrderTypeIcon.md +7 -0
  443. package/docs/variables/GroupAccessIcon.md +7 -0
  444. package/docs/variables/GroupIcon.md +7 -0
  445. package/docs/variables/HomePictogram.md +7 -0
  446. package/docs/variables/HospitalBedIcon.md +7 -0
  447. package/docs/variables/Icon.md +9 -0
  448. package/docs/variables/ImageMedicalIcon.md +7 -0
  449. package/docs/variables/InPatientPictogram.md +7 -0
  450. package/docs/variables/InformationFilledIcon.md +7 -0
  451. package/docs/variables/InformationIcon.md +7 -0
  452. package/docs/variables/InformationSquareIcon.md +7 -0
  453. package/docs/variables/InventoryManagementIcon.md +7 -0
  454. package/docs/variables/LabOrderIcon.md +7 -0
  455. package/docs/variables/LaboratoryPictogram.md +7 -0
  456. package/docs/variables/LeftNavMenu.md +13 -0
  457. package/docs/variables/ListCheckedIcon.md +7 -0
  458. package/docs/variables/LocationIcon.md +7 -0
  459. package/docs/variables/LocationPicker.md +7 -0
  460. package/docs/variables/MaterialOrderIcon.md +7 -0
  461. package/docs/variables/MaximizeIcon.md +7 -0
  462. package/docs/variables/MaybeIcon.md +16 -0
  463. package/docs/variables/MaybePictogram.md +16 -0
  464. package/docs/variables/MedicationIcon.md +7 -0
  465. package/docs/variables/MessageQueueIcon.md +7 -0
  466. package/docs/variables/MicroscopeIcon.md +7 -0
  467. package/docs/variables/MoneyIcon.md +9 -0
  468. package/docs/variables/MotherIcon.md +7 -0
  469. package/docs/variables/MovementIcon.md +7 -0
  470. package/docs/variables/OpenmrsDatePicker.md +9 -0
  471. package/docs/variables/OverflowMenuHorizontalIcon.md +7 -0
  472. package/docs/variables/OverflowMenuVerticalIcon.md +7 -0
  473. package/docs/variables/PageHeader.md +30 -0
  474. package/docs/variables/PageHeaderContent.md +21 -0
  475. package/docs/variables/PasswordIcon.md +7 -0
  476. package/docs/variables/PatientListsPictogram.md +7 -0
  477. package/docs/variables/PedestrianFamilyIcon.md +7 -0
  478. package/docs/variables/PenIcon.md +7 -0
  479. package/docs/variables/PharmacyPictogram.md +7 -0
  480. package/docs/variables/Pictogram.md +9 -0
  481. package/docs/variables/PrinterIcon.md +7 -0
  482. package/docs/variables/ProcedureOrderIcon.md +7 -0
  483. package/docs/variables/ProgramsIcon.md +7 -0
  484. package/docs/variables/RadiologyIcon.md +7 -0
  485. package/docs/variables/ReferralOrderIcon.md +7 -0
  486. package/docs/variables/RegistrationPictogram.md +7 -0
  487. package/docs/variables/RenderIfValueIsTruthy.md +21 -0
  488. package/docs/variables/RenewIcon.md +7 -0
  489. package/docs/variables/ReportIcon.md +7 -0
  490. package/docs/variables/ResetIcon.md +7 -0
  491. package/docs/variables/ResponsiveWrapper.md +11 -0
  492. package/docs/variables/SaveIcon.md +7 -0
  493. package/docs/variables/SearchIcon.md +7 -0
  494. package/docs/variables/ServiceQueuesPictogram.md +7 -0
  495. package/docs/variables/ShoppingCartAddItemIcon.md +11 -0
  496. package/docs/variables/ShoppingCartArrowDownIcon.md +9 -0
  497. package/docs/variables/ShoppingCartIcon.md +9 -0
  498. package/docs/variables/StickyNoteAddIcon.md +9 -0
  499. package/docs/variables/StockManagementPictogram.md +7 -0
  500. package/docs/variables/SwitcherIcon.md +7 -0
  501. package/docs/variables/SyringeIcon.md +7 -0
  502. package/docs/variables/TableIcon.md +7 -0
  503. package/docs/variables/TableOfContentsIcon.md +9 -0
  504. package/docs/variables/TimeIcon.md +9 -0
  505. package/docs/variables/ToolsIcon.md +7 -0
  506. package/docs/variables/TranslateIcon.md +7 -0
  507. package/docs/variables/TrashCanIcon.md +7 -0
  508. package/docs/variables/TreeViewAltIcon.md +7 -0
  509. package/docs/variables/UserAvatarIcon.md +9 -0
  510. package/docs/variables/UserFollowIcon.md +7 -0
  511. package/docs/variables/UserHasAccess.md +35 -0
  512. package/docs/variables/UserIcon.md +7 -0
  513. package/docs/variables/UserXrayIcon.md +11 -0
  514. package/docs/variables/ViewIcon.md +7 -0
  515. package/docs/variables/ViewOffIcon.md +7 -0
  516. package/docs/variables/WarningIcon.md +7 -0
  517. package/docs/variables/attachmentUrl.md +7 -0
  518. package/docs/variables/backendDependencies.md +17 -0
  519. package/docs/variables/defaultVisitCustomRepresentation.md +7 -0
  520. package/docs/variables/fhirBaseUrl.md +7 -0
  521. package/docs/variables/getAsyncExtensionLifecycle.md +35 -0
  522. package/docs/variables/getStartedVisit.md +9 -0
  523. package/docs/variables/isUrl.md +9 -0
  524. package/docs/variables/offlineUuidPrefix.md +7 -0
  525. package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +7 -0
  526. package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +7 -0
  527. package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +7 -0
  528. package/docs/variables/restBaseUrl.md +7 -0
  529. package/docs/variables/sessionEndpoint.md +7 -0
  530. package/docs/variables/useConnectedExtensions.md +25 -0
  531. package/docs/variables/useExtensionStore.md +55 -0
  532. package/docs/variables/validators.md +78 -0
  533. package/package.json +24 -20
  534. package/rspack.config.cjs +1 -8
  535. package/tsconfig.build.json +2 -1
  536. package/typedoc.json +16 -3
  537. package/docs/.nojekyll +0 -1
  538. package/docs/enums/Type.md +0 -107
  539. package/docs/enums/VisitMode.md +0 -41
  540. package/docs/enums/VisitStatus.md +0 -30
  541. package/docs/interfaces/ExtensionSlotConfigObject.md +0 -47
  542. package/docs/interfaces/OldExtensionSlotBaseProps.md +0 -67
package/docs/interfaces/Location.md CHANGED
@@ -1,408 +1,305 @@
1
- [@openmrs/esm-framework](../API.md) / Location
1
+ [O3 Framework](../API.md) / Location
2
2
 
3
3
  # Interface: Location
4
4
 
5
- ## Hierarchy
5
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L3)
6
6
 
7
- - `OpenmrsResource`
8
-
9
- ↳ **`Location`**
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [address1](Location.md#address1)
16
- - [address10](Location.md#address10)
17
- - [address11](Location.md#address11)
18
- - [address12](Location.md#address12)
19
- - [address13](Location.md#address13)
20
- - [address14](Location.md#address14)
21
- - [address15](Location.md#address15)
22
- - [address2](Location.md#address2)
23
- - [address3](Location.md#address3)
24
- - [address4](Location.md#address4)
25
- - [address5](Location.md#address5)
26
- - [address6](Location.md#address6)
27
- - [address7](Location.md#address7)
28
- - [address8](Location.md#address8)
29
- - [address9](Location.md#address9)
30
- - [attributes](Location.md#attributes)
31
- - [auditInfo](Location.md#auditinfo)
32
- - [childLocation](Location.md#childlocation)
33
- - [cityVillage](Location.md#cityvillage)
34
- - [country](Location.md#country)
35
- - [countyDistrict](Location.md#countydistrict)
36
- - [description](Location.md#description)
37
- - [display](Location.md#display)
38
- - [latitude](Location.md#latitude)
39
- - [links](Location.md#links)
40
- - [longitude](Location.md#longitude)
41
- - [name](Location.md#name)
42
- - [parentLocation](Location.md#parentlocation)
43
- - [postalCode](Location.md#postalcode)
44
- - [resourceVersion](Location.md#resourceversion)
45
- - [retired](Location.md#retired)
46
- - [stateProvince](Location.md#stateprovince)
47
- - [tags](Location.md#tags)
48
- - [uuid](Location.md#uuid)
49
-
50
- ## Properties
51
-
52
- ### address1
53
-
54
- • `Optional` **address1**: `string`
55
-
56
- #### Defined in
57
-
58
- [packages/framework/esm-emr-api/src/types/location-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L13)
59
-
60
- ___
61
-
62
- ### address10
7
+ ## Extends
63
8
 
64
- • `Optional` **address10**: `string`
65
-
66
- #### Defined in
67
-
68
- [packages/framework/esm-emr-api/src/types/location-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L22)
69
-
70
- ___
71
-
72
- ### address11
73
-
74
- • `Optional` **address11**: `string`
9
+ - `OpenmrsResource`
75
10
 
76
- #### Defined in
11
+ ## Indexable
77
12
 
78
- [packages/framework/esm-emr-api/src/types/location-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L23)
13
+ \[`anythingElse`: `string`\]: `any`
79
14
 
80
- ___
15
+ ## Properties
81
16
 
82
- ### address12
17
+ ### address1?
83
18
 
84
- • `Optional` **address12**: `string`
19
+ > `optional` **address1**: `string`
85
20
 
86
- #### Defined in
21
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L13)
87
22
 
88
- [packages/framework/esm-emr-api/src/types/location-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L24)
23
+ ***
89
24
 
90
- ___
25
+ ### address10?
91
26
 
92
- ### address13
27
+ > `optional` **address10**: `string`
93
28
 
94
- • `Optional` **address13**: `string`
29
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L22)
95
30
 
96
- #### Defined in
31
+ ***
97
32
 
98
- [packages/framework/esm-emr-api/src/types/location-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L25)
33
+ ### address11?
99
34
 
100
- ___
35
+ > `optional` **address11**: `string`
101
36
 
102
- ### address14
37
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L23)
103
38
 
104
- • `Optional` **address14**: `string`
39
+ ***
105
40
 
106
- #### Defined in
41
+ ### address12?
107
42
 
108
- [packages/framework/esm-emr-api/src/types/location-resource.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L26)
43
+ > `optional` **address12**: `string`
109
44
 
110
- ___
45
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L24)
111
46
 
112
- ### address15
47
+ ***
113
48
 
114
- • `Optional` **address15**: `string`
49
+ ### address13?
115
50
 
116
- #### Defined in
51
+ > `optional` **address13**: `string`
117
52
 
118
- [packages/framework/esm-emr-api/src/types/location-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L27)
53
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L25)
119
54
 
120
- ___
55
+ ***
121
56
 
122
- ### address2
57
+ ### address14?
123
58
 
124
- • `Optional` **address2**: `string`
59
+ > `optional` **address14**: `string`
125
60
 
126
- #### Defined in
61
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L26)
127
62
 
128
- [packages/framework/esm-emr-api/src/types/location-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L14)
63
+ ***
129
64
 
130
- ___
65
+ ### address15?
131
66
 
132
- ### address3
67
+ > `optional` **address15**: `string`
133
68
 
134
- • `Optional` **address3**: `string`
69
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L27)
135
70
 
136
- #### Defined in
71
+ ***
137
72
 
138
- [packages/framework/esm-emr-api/src/types/location-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L15)
73
+ ### address2?
139
74
 
140
- ___
75
+ > `optional` **address2**: `string`
141
76
 
142
- ### address4
77
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L14)
143
78
 
144
- • `Optional` **address4**: `string`
79
+ ***
145
80
 
146
- #### Defined in
81
+ ### address3?
147
82
 
148
- [packages/framework/esm-emr-api/src/types/location-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L16)
83
+ > `optional` **address3**: `string`
149
84
 
150
- ___
85
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L15)
151
86
 
152
- ### address5
87
+ ***
153
88
 
154
- • `Optional` **address5**: `string`
89
+ ### address4?
155
90
 
156
- #### Defined in
91
+ > `optional` **address4**: `string`
157
92
 
158
- [packages/framework/esm-emr-api/src/types/location-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L17)
93
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L16)
159
94
 
160
- ___
95
+ ***
161
96
 
162
- ### address6
97
+ ### address5?
163
98
 
164
- • `Optional` **address6**: `string`
99
+ > `optional` **address5**: `string`
165
100
 
166
- #### Defined in
101
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L17)
167
102
 
168
- [packages/framework/esm-emr-api/src/types/location-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L18)
103
+ ***
169
104
 
170
- ___
105
+ ### address6?
171
106
 
172
- ### address7
107
+ > `optional` **address6**: `string`
173
108
 
174
- • `Optional` **address7**: `string`
109
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L18)
175
110
 
176
- #### Defined in
111
+ ***
177
112
 
178
- [packages/framework/esm-emr-api/src/types/location-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L19)
113
+ ### address7?
179
114
 
180
- ___
115
+ > `optional` **address7**: `string`
181
116
 
182
- ### address8
117
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L19)
183
118
 
184
- • `Optional` **address8**: `string`
119
+ ***
185
120
 
186
- #### Defined in
121
+ ### address8?
187
122
 
188
- [packages/framework/esm-emr-api/src/types/location-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L20)
123
+ > `optional` **address8**: `string`
189
124
 
190
- ___
125
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L20)
191
126
 
192
- ### address9
127
+ ***
193
128
 
194
- • `Optional` **address9**: `string`
129
+ ### address9?
195
130
 
196
- #### Defined in
131
+ > `optional` **address9**: `string`
197
132
 
198
- [packages/framework/esm-emr-api/src/types/location-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L21)
133
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L21)
199
134
 
200
- ___
135
+ ***
201
136
 
202
- ### attributes
137
+ ### attributes?
203
138
 
204
- • `Optional` **attributes**: `OpenmrsResource`[]
139
+ > `optional` **attributes**: `OpenmrsResource`[]
205
140
 
206
- #### Defined in
141
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L29)
207
142
 
208
- [packages/framework/esm-emr-api/src/types/location-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L29)
143
+ ***
209
144
 
210
- ___
145
+ ### auditInfo?
211
146
 
212
- ### auditInfo
147
+ > `optional` **auditInfo**: `AuditInfo`
213
148
 
214
- • `Optional` **auditInfo**: `AuditInfo`
149
+ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
215
150
 
216
151
  #### Inherited from
217
152
 
218
- OpenmrsResource.auditInfo
219
-
220
- #### Defined in
221
-
222
- packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
153
+ `OpenmrsResource.auditInfo`
223
154
 
224
- ___
155
+ ***
225
156
 
226
- ### childLocation
157
+ ### childLocation?
227
158
 
228
- • `Optional` **childLocation**: [`Location`](Location.md)
159
+ > `optional` **childLocation**: `Location`
229
160
 
230
- #### Defined in
161
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L31)
231
162
 
232
- [packages/framework/esm-emr-api/src/types/location-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L31)
163
+ ***
233
164
 
234
- ___
165
+ ### cityVillage?
235
166
 
236
- ### cityVillage
167
+ > `optional` **cityVillage**: `string`
237
168
 
238
- • `Optional` **cityVillage**: `string`
169
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L6)
239
170
 
240
- #### Defined in
171
+ ***
241
172
 
242
- [packages/framework/esm-emr-api/src/types/location-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L6)
173
+ ### country?
243
174
 
244
- ___
175
+ > `optional` **country**: `string`
245
176
 
246
- ### country
177
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L8)
247
178
 
248
- • `Optional` **country**: `string`
179
+ ***
249
180
 
250
- #### Defined in
181
+ ### countyDistrict?
251
182
 
252
- [packages/framework/esm-emr-api/src/types/location-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L8)
183
+ > `optional` **countyDistrict**: `string`
253
184
 
254
- ___
185
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L10)
255
186
 
256
- ### countyDistrict
187
+ ***
257
188
 
258
- • `Optional` **countyDistrict**: `string`
189
+ ### description?
259
190
 
260
- #### Defined in
191
+ > `optional` **description**: `string`
261
192
 
262
- [packages/framework/esm-emr-api/src/types/location-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L10)
193
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L5)
263
194
 
264
- ___
195
+ ***
265
196
 
266
- ### description
197
+ ### display?
267
198
 
268
- • `Optional` **description**: `string`
199
+ > `optional` **display**: `string`
269
200
 
270
- #### Defined in
271
-
272
- [packages/framework/esm-emr-api/src/types/location-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L5)
273
-
274
- ___
275
-
276
- ### display
277
-
278
- • `Optional` **display**: `string`
201
+ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
279
202
 
280
203
  #### Inherited from
281
204
 
282
- OpenmrsResource.display
283
-
284
- #### Defined in
205
+ `OpenmrsResource.display`
285
206
 
286
- packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
207
+ ***
287
208
 
288
- ___
209
+ ### latitude?
289
210
 
290
- ### latitude
211
+ > `optional` **latitude**: `string`
291
212
 
292
- • `Optional` **latitude**: `string`
213
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L11)
293
214
 
294
- #### Defined in
215
+ ***
295
216
 
296
- [packages/framework/esm-emr-api/src/types/location-resource.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L11)
217
+ ### links?
297
218
 
298
- ___
219
+ > `optional` **links**: `Link`[]
299
220
 
300
- ### links
301
-
302
- • `Optional` **links**: `Link`[]
221
+ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
303
222
 
304
223
  #### Inherited from
305
224
 
306
- OpenmrsResource.links
307
-
308
- #### Defined in
309
-
310
- packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
311
-
312
- ___
313
-
314
- ### longitude
225
+ `OpenmrsResource.links`
315
226
 
316
- • `Optional` **longitude**: `string`
227
+ ***
317
228
 
318
- #### Defined in
229
+ ### longitude?
319
230
 
320
- [packages/framework/esm-emr-api/src/types/location-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L12)
231
+ > `optional` **longitude**: `string`
321
232
 
322
- ___
233
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L12)
323
234
 
324
- ### name
235
+ ***
325
236
 
326
- • `Optional` **name**: `string`
237
+ ### name?
327
238
 
328
- #### Defined in
239
+ > `optional` **name**: `string`
329
240
 
330
- [packages/framework/esm-emr-api/src/types/location-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L4)
241
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L4)
331
242
 
332
- ___
243
+ ***
333
244
 
334
- ### parentLocation
245
+ ### parentLocation?
335
246
 
336
- • `Optional` **parentLocation**: [`Location`](Location.md)
247
+ > `optional` **parentLocation**: `Location`
337
248
 
338
- #### Defined in
249
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L30)
339
250
 
340
- [packages/framework/esm-emr-api/src/types/location-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L30)
251
+ ***
341
252
 
342
- ___
253
+ ### postalCode?
343
254
 
344
- ### postalCode
255
+ > `optional` **postalCode**: `string`
345
256
 
346
- • `Optional` **postalCode**: `string`
257
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L9)
347
258
 
348
- #### Defined in
259
+ ***
349
260
 
350
- [packages/framework/esm-emr-api/src/types/location-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L9)
261
+ ### resourceVersion?
351
262
 
352
- ___
263
+ > `optional` **resourceVersion**: `string`
353
264
 
354
- ### resourceVersion
355
-
356
- • `Optional` **resourceVersion**: `string`
265
+ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
357
266
 
358
267
  #### Inherited from
359
268
 
360
- OpenmrsResource.resourceVersion
361
-
362
- #### Defined in
363
-
364
- packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
365
-
366
- ___
367
-
368
- ### retired
269
+ `OpenmrsResource.resourceVersion`
369
270
 
370
- • `Optional` **retired**: `boolean`
271
+ ***
371
272
 
372
- #### Defined in
273
+ ### retired?
373
274
 
374
- [packages/framework/esm-emr-api/src/types/location-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L32)
275
+ > `optional` **retired**: `boolean`
375
276
 
376
- ___
277
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L32)
377
278
 
378
- ### stateProvince
279
+ ***
379
280
 
380
- • `Optional` **stateProvince**: `string`
281
+ ### stateProvince?
381
282
 
382
- #### Defined in
283
+ > `optional` **stateProvince**: `string`
383
284
 
384
- [packages/framework/esm-emr-api/src/types/location-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L7)
285
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L7)
385
286
 
386
- ___
287
+ ***
387
288
 
388
- ### tags
289
+ ### tags?
389
290
 
390
- • `Optional` **tags**: `OpenmrsResource`[]
291
+ > `optional` **tags**: `OpenmrsResource`[]
391
292
 
392
- #### Defined in
293
+ Defined in: [packages/framework/esm-emr-api/src/types/location-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L28)
393
294
 
394
- [packages/framework/esm-emr-api/src/types/location-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/location-resource.ts#L28)
395
-
396
- ___
295
+ ***
397
296
 
398
297
  ### uuid
399
298
 
400
- • **uuid**: `string`
401
-
402
- #### Inherited from
299
+ > **uuid**: `string`
403
300
 
404
- OpenmrsResource.uuid
301
+ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
405
302
 
406
- #### Defined in
303
+ #### Inherited from
407
304
 
408
- packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
305
+ `OpenmrsResource.uuid`