@openmrs/esm-framework 9.0.3-pre.4151 → 9.0.3-pre.4166

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 (123) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/API.md +7 -0
  3. package/docs/functions/age.md +6 -6
  4. package/docs/functions/calculateInterpretation.md +2 -2
  5. package/docs/functions/canAccessStorage.md +4 -4
  6. package/docs/functions/convertToLocaleCalendar.md +1 -1
  7. package/docs/functions/createAttachment.md +2 -2
  8. package/docs/functions/createErrorHandler.md +1 -1
  9. package/docs/functions/deleteAttachmentPermanently.md +2 -2
  10. package/docs/functions/dispatchNotificationShown.md +1 -1
  11. package/docs/functions/dispatchPrecacheStaticDependencies.md +4 -4
  12. package/docs/functions/displayName.md +1 -1
  13. package/docs/functions/fetchCurrentPatient.md +1 -1
  14. package/docs/functions/formatDate.md +1 -1
  15. package/docs/functions/formatDatetime.md +1 -1
  16. package/docs/functions/formatDuration.md +1 -1
  17. package/docs/functions/formatPartialDate.md +4 -4
  18. package/docs/functions/formatPatientName.md +1 -1
  19. package/docs/functions/formatTime.md +1 -1
  20. package/docs/functions/formattedName.md +1 -1
  21. package/docs/functions/getAttachmentByUuid.md +2 -2
  22. package/docs/functions/getAttachments.md +2 -2
  23. package/docs/functions/getCoreTranslation.md +1 -1
  24. package/docs/functions/getDefaultCalendar.md +1 -1
  25. package/docs/functions/getDefaultsFromConfigSchema.md +1 -1
  26. package/docs/functions/getLocale.md +1 -1
  27. package/docs/functions/getPatientName.md +1 -1
  28. package/docs/functions/getVisitsForPatient.md +2 -2
  29. package/docs/functions/isOmrsDateStrict.md +1 -1
  30. package/docs/functions/isOmrsDateToday.md +1 -1
  31. package/docs/functions/isOnline.md +1 -1
  32. package/docs/functions/isVersionSatisfied.md +1 -1
  33. package/docs/functions/normalizeInterpretation.md +3 -3
  34. package/docs/functions/parseDate.md +1 -1
  35. package/docs/functions/registerDefaultCalendar.md +1 -1
  36. package/docs/functions/reportError.md +1 -1
  37. package/docs/functions/retry.md +4 -4
  38. package/docs/functions/saveVisit.md +2 -2
  39. package/docs/functions/selectPreferredName.md +1 -1
  40. package/docs/functions/shallowEqual.md +1 -1
  41. package/docs/functions/subscribeActionableNotificationShown.md +1 -1
  42. package/docs/functions/subscribeConnectivity.md +1 -1
  43. package/docs/functions/subscribeConnectivityChanged.md +1 -1
  44. package/docs/functions/subscribeNotificationShown.md +1 -1
  45. package/docs/functions/subscribePrecacheStaticDependencies.md +1 -1
  46. package/docs/functions/subscribeSnackbarShown.md +1 -1
  47. package/docs/functions/subscribeToastShown.md +1 -1
  48. package/docs/functions/toDateObjectStrict.md +1 -1
  49. package/docs/functions/toOmrsIsoString.md +4 -4
  50. package/docs/functions/updateVisit.md +2 -2
  51. package/docs/functions/useAssignedExtensions.md +2 -2
  52. package/docs/functions/useAttachments.md +2 -2
  53. package/docs/functions/useEmrConfiguration.md +1 -1
  54. package/docs/functions/useExtensionSlotMeta.md +1 -1
  55. package/docs/functions/useExtensionSlotStore.md +2 -2
  56. package/docs/functions/useFhirPagination.md +1 -1
  57. package/docs/functions/useLeftNav.md +1 -1
  58. package/docs/functions/useLeftNavStore.md +2 -2
  59. package/docs/functions/useLocations.md +2 -2
  60. package/docs/functions/useOpenmrsPagination.md +1 -1
  61. package/docs/functions/useOpenmrsSWR.md +2 -2
  62. package/docs/functions/useSession.md +2 -2
  63. package/docs/functions/useVisitContextStore.md +2 -2
  64. package/docs/functions/useVisitTypes.md +2 -2
  65. package/docs/interfaces/AssignedExtension.md +1 -1
  66. package/docs/interfaces/ConfigurableLinkProps.md +1 -1
  67. package/docs/interfaces/ConnectedExtension.md +1 -1
  68. package/docs/interfaces/ConnectivityChangedEvent.md +2 -2
  69. package/docs/interfaces/Diagnosis.md +20 -16
  70. package/docs/interfaces/Drug.md +17 -13
  71. package/docs/interfaces/EmrApiConfigurationResponse.md +51 -51
  72. package/docs/interfaces/Encounter.md +18 -14
  73. package/docs/interfaces/EncounterProvider.md +18 -14
  74. package/docs/interfaces/EncounterRole.md +17 -13
  75. package/docs/interfaces/EncounterType.md +17 -13
  76. package/docs/interfaces/ExtensionSlotBaseProps.md +3 -3
  77. package/docs/interfaces/ExtensionSlotProps.md +11 -11
  78. package/docs/interfaces/FeatureFlagDefinition.md +4 -4
  79. package/docs/interfaces/ImportMap.md +2 -2
  80. package/docs/interfaces/Location.md +19 -15
  81. package/docs/interfaces/NumericObservationProps.md +1 -1
  82. package/docs/interfaces/Obs.md +22 -18
  83. package/docs/interfaces/OpenWorkspace.md +24 -24
  84. package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
  85. package/docs/interfaces/OpenmrsResource.md +9 -0
  86. package/docs/interfaces/Order.md +26 -22
  87. package/docs/interfaces/Patient.md +8 -8
  88. package/docs/interfaces/PatientIdentifier.md +7 -7
  89. package/docs/interfaces/PatientIdentifierType.md +7 -7
  90. package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -1
  91. package/docs/interfaces/ResourceLoader.md +2 -2
  92. package/docs/interfaces/RetryOptions.md +4 -4
  93. package/docs/interfaces/ShowActionableNotificationEvent.md +7 -7
  94. package/docs/interfaces/ShowNotificationEvent.md +6 -6
  95. package/docs/interfaces/ShowSnackbarEvent.md +9 -9
  96. package/docs/interfaces/ShowToastEvent.md +6 -6
  97. package/docs/interfaces/SpaConfig.md +6 -6
  98. package/docs/interfaces/UseServerFetchAllOptions.md +2 -2
  99. package/docs/interfaces/UseServerInfiniteOptions.md +2 -2
  100. package/docs/interfaces/UseServerPaginationOptions.md +2 -2
  101. package/docs/interfaces/Visit.md +1 -1
  102. package/docs/interfaces/VisitReturnType.md +2 -2
  103. package/docs/interfaces/WorkspaceDefinition2.md +4 -4
  104. package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
  105. package/docs/interfaces/WorkspaceGroupDefinition2.md +6 -6
  106. package/docs/interfaces/WorkspaceRegistration.md +4 -0
  107. package/docs/interfaces/WorkspaceWindowDefinition2.md +7 -7
  108. package/docs/type-aliases/CurrentPatient.md +1 -1
  109. package/docs/type-aliases/DateInput.md +1 -1
  110. package/docs/type-aliases/ExtensionDefinition.md +12 -12
  111. package/docs/type-aliases/FormatDateMode.md +1 -1
  112. package/docs/type-aliases/FormatDateOptions.md +10 -10
  113. package/docs/type-aliases/ModalDefinition.md +3 -3
  114. package/docs/type-aliases/NameUse.md +1 -1
  115. package/docs/type-aliases/OpenmrsRoutes.md +1 -1
  116. package/docs/type-aliases/PageDefinition.md +1 -1
  117. package/docs/type-aliases/SpaEnvironment.md +1 -1
  118. package/docs/type-aliases/UseOpenmrsSWROptions.md +1 -1
  119. package/docs/type-aliases/WorkspaceDefinition.md +14 -14
  120. package/docs/type-aliases/WorkspaceWindowState.md +1 -1
  121. package/docs/variables/useConnectedExtensions.md +2 -2
  122. package/docs/variables/useExtensionStore.md +9 -9
  123. package/package.json +20 -20
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **subscribePrecacheStaticDependencies**(`cb`): () => `void`
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/events.d.ts:14
7
+ Defined in: [packages/framework/esm-globals/src/events.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L39)
8
8
 
9
9
  ## Parameters
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **subscribeSnackbarShown**(`cb`): () => `void`
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/events.d.ts:64
7
+ Defined in: [packages/framework/esm-globals/src/events.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L130)
8
8
 
9
9
  ## Parameters
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **subscribeToastShown**(`cb`): () => `void`
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/events.d.ts:62
7
+ Defined in: [packages/framework/esm-globals/src/events.ts:123](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L123)
8
8
 
9
9
  ## Parameters
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **toDateObjectStrict**(`omrsDateString`): `null` \| `Date`
6
6
 
7
- Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:24
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L74)
8
8
 
9
9
  Converts the object to a date object if it is an OpenMRS ISO date time string.
10
10
  Otherwise returns null.
@@ -2,9 +2,9 @@
2
2
 
3
3
  # Function: toOmrsIsoString()
4
4
 
5
- > **toOmrsIsoString**(`date`, `toUTC?`): `string`
5
+ > **toOmrsIsoString**(`date`, `toUTC`): `string`
6
6
 
7
- Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:28
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L85)
8
8
 
9
9
  Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
10
10
 
@@ -14,9 +14,9 @@ Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
14
14
 
15
15
  [`DateInput`](../type-aliases/DateInput.md)
16
16
 
17
- ### toUTC?
17
+ ### toUTC
18
18
 
19
- `boolean`
19
+ `boolean` = `false`
20
20
 
21
21
  ## Returns
22
22
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: updateVisit()
4
4
 
5
- > **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>
5
+ > **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<[`Visit`](../interfaces/Visit.md)\>\>
6
6
 
7
7
  Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:162](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L162)
8
8
 
@@ -30,7 +30,7 @@ An AbortController to allow cancellation of the request.
30
30
 
31
31
  ## Returns
32
32
 
33
- `Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>
33
+ `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<[`Visit`](../interfaces/Visit.md)\>\>
34
34
 
35
35
  A Promise that resolves with the FetchResponse containing the updated Visit.
36
36
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useAssignedExtensions()
4
4
 
5
- > **useAssignedExtensions**(`slotName`): `AssignedExtension`[]
5
+ > **useAssignedExtensions**(`slotName`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L8)
8
8
 
@@ -18,4 +18,4 @@ The name of the slot to get the assigned extensions for.
18
18
 
19
19
  ## Returns
20
20
 
21
- `AssignedExtension`[]
21
+ [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
@@ -37,7 +37,7 @@ An object containing:
37
37
 
38
38
  ### data
39
39
 
40
- > **data**: `AttachmentResponse`[]
40
+ > **data**: [`AttachmentResponse`](../interfaces/AttachmentResponse.md)[]
41
41
 
42
42
  ### error
43
43
 
@@ -53,7 +53,7 @@ An object containing:
53
53
 
54
54
  ### mutate
55
55
 
56
- > **mutate**: `KeyedMutator`\<`FetchResponse`\<\{ `results`: `AttachmentResponse`[]; \}\>\>
56
+ > **mutate**: `KeyedMutator`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<\{ `results`: [`AttachmentResponse`](../interfaces/AttachmentResponse.md)[]; \}\>\>
57
57
 
58
58
  ## Example
59
59
 
@@ -32,4 +32,4 @@ Object containing:
32
32
 
33
33
  ### mutateEmrConfiguration
34
34
 
35
- > **mutateEmrConfiguration**: `KeyedMutator`\<`FetchResponse`\<[`EmrApiConfigurationResponse`](../interfaces/EmrApiConfigurationResponse.md)\>\> = `swrData.mutate`
35
+ > **mutateEmrConfiguration**: `KeyedMutator`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<[`EmrApiConfigurationResponse`](../interfaces/EmrApiConfigurationResponse.md)\>\> = `swrData.mutate`
@@ -12,7 +12,7 @@ Extract meta data from all extension for a given extension slot.
12
12
 
13
13
  ### T
14
14
 
15
- `T` = `ExtensionMeta`
15
+ `T` = [`ExtensionMeta`](../interfaces/ExtensionMeta.md)
16
16
 
17
17
  ## Parameters
18
18
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useExtensionSlotStore()
4
4
 
5
- > **useExtensionSlotStore**(`slot`): `ExtensionSlotState`
5
+ > **useExtensionSlotStore**(`slot`): [`ExtensionSlotState`](../interfaces/ExtensionSlotState.md)
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionSlotStore.ts#L5)
8
8
 
@@ -14,4 +14,4 @@ Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotStore.ts:5](
14
14
 
15
15
  ## Returns
16
16
 
17
- `ExtensionSlotState`
17
+ [`ExtensionSlotState`](../interfaces/ExtensionSlotState.md)
@@ -99,7 +99,7 @@ The error object thrown by the fetcher function.
99
99
 
100
100
  ### mutate
101
101
 
102
- > **mutate**: `KeyedMutator`\<`FetchResponse`\<`Bundle`\>\>
102
+ > **mutate**: `KeyedMutator`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`Bundle`\>\>
103
103
 
104
104
  ### paginated
105
105
 
@@ -17,7 +17,7 @@ unregistered when it unmounts.
17
17
 
18
18
  ### params
19
19
 
20
- `Omit`\<`SetLeftNavParams`, `"module"`\>
20
+ `Omit`\<[`SetLeftNavParams`](../interfaces/SetLeftNavParams.md), `"module"`\>
21
21
 
22
22
  Configuration parameters for the left navigation, excluding the
23
23
  module name which is automatically determined from the component context.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useLeftNavStore()
4
4
 
5
- > **useLeftNavStore**(): `LeftNavStore`
5
+ > **useLeftNavStore**(): [`LeftNavStore`](../interfaces/LeftNavStore.md)
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useLeftNavStore.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLeftNavStore.ts#L20)
8
8
 
@@ -11,7 +11,7 @@ The component will re-render whenever the left navigation state changes.
11
11
 
12
12
  ## Returns
13
13
 
14
- `LeftNavStore`
14
+ [`LeftNavStore`](../interfaces/LeftNavStore.md)
15
15
 
16
16
  The current state of the left navigation store.
17
17
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useLocations()
4
4
 
5
- > **useLocations**(`tagUuidOrName`, `query`): `Location`[]
5
+ > **useLocations**(`tagUuidOrName`, `query`): [`Location`](../interfaces/Location.md)[]
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useLocations.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLocations.tsx#L29)
8
8
 
@@ -27,7 +27,7 @@ Optional search query string to filter locations. Pass `null`
27
27
 
28
28
  ## Returns
29
29
 
30
- `Location`[]
30
+ [`Location`](../interfaces/Location.md)[]
31
31
 
32
32
  An array of Location objects. Returns an empty array while loading
33
33
  or if an error occurs.
@@ -110,7 +110,7 @@ The error object thrown by the fetcher function.
110
110
 
111
111
  ### mutate
112
112
 
113
- > **mutate**: `KeyedMutator`\<`FetchResponse`\<`OpenMRSPaginatedResponse`\<`T`\>\>\>
113
+ > **mutate**: `KeyedMutator`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`OpenMRSPaginatedResponse`\<`T`\>\>\>
114
114
 
115
115
  ### paginated
116
116
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useOpenmrsSWR()
4
4
 
5
- > **useOpenmrsSWR**\<`DataType`, `ErrorType`\>(`key`, `options`): `SWRResponse`\<`FetchResponse`\<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`\<`FetchResponse`\<`DataType`\>, `ErrorType`, `BareFetcher`\<`FetchResponse`\<`DataType`\>\>\>\>
5
+ > **useOpenmrsSWR**\<`DataType`, `ErrorType`\>(`key`, `options`): `SWRResponse`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`DataType`\>, `ErrorType`, `BareFetcher`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`DataType`\>\>\>\>
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L70)
8
8
 
@@ -39,7 +39,7 @@ An object of optional parameters to provide, including a [FetchConfig](../interf
39
39
 
40
40
  ## Returns
41
41
 
42
- `SWRResponse`\<`FetchResponse`\<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`\<`FetchResponse`\<`DataType`\>, `ErrorType`, `BareFetcher`\<`FetchResponse`\<`DataType`\>\>\>\>
42
+ `SWRResponse`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`DataType`\>, `ErrorType`, `BareFetcher`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`DataType`\>\>\>\>
43
43
 
44
44
  ## Examples
45
45
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useSession()
4
4
 
5
- > **useSession**(): `Session`
5
+ > **useSession**(): [`Session`](../interfaces/Session.md)
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useSession.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useSession.ts#L17)
8
8
 
@@ -14,6 +14,6 @@ or throw for Suspense. It will never return `null`/`undefined`.
14
14
 
15
15
  ## Returns
16
16
 
17
- `Session`
17
+ [`Session`](../interfaces/Session.md)
18
18
 
19
19
  Current user session information
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useVisitContextStore()
4
4
 
5
- > **useVisitContextStore**(`mutateVisitCallback?`): `VisitStoreState` & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null`; `patientUuid?`: `undefined`; \} \| \{ `manuallySetVisitUuid`: `string`; `patientUuid`: `undefined` \| `string`; \}; \}\>
5
+ > **useVisitContextStore**(`mutateVisitCallback?`): [`VisitStoreState`](../interfaces/VisitStoreState.md) & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null`; `patientUuid?`: `undefined`; \} \| \{ `manuallySetVisitUuid`: `string`; `patientUuid`: `undefined` \| `string`; \}; \}\>
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useVisitContextStore.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitContextStore.ts#L30)
8
8
 
@@ -20,4 +20,4 @@ callbacks also registered into the store)
20
20
 
21
21
  ## Returns
22
22
 
23
- `VisitStoreState` & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null`; `patientUuid?`: `undefined`; \} \| \{ `manuallySetVisitUuid`: `string`; `patientUuid`: `undefined` \| `string`; \}; \}\>
23
+ [`VisitStoreState`](../interfaces/VisitStoreState.md) & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null`; `patientUuid?`: `undefined`; \} \| \{ `manuallySetVisitUuid`: `string`; `patientUuid`: `undefined` \| `string`; \}; \}\>
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Function: useVisitTypes()
4
4
 
5
- > **useVisitTypes**(): `VisitType`[]
5
+ > **useVisitTypes**(): [`VisitType`](../interfaces/VisitType.md)[]
6
6
 
7
7
  Defined in: [packages/framework/esm-react-utils/src/useVisitTypes.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitTypes.ts#L27)
8
8
 
@@ -11,7 +11,7 @@ OpenMRS server. The data is fetched once when the component mounts.
11
11
 
12
12
  ## Returns
13
13
 
14
- `VisitType`[]
14
+ [`VisitType`](../interfaces/VisitType.md)[]
15
15
 
16
16
  An array of VisitType objects. Returns an empty array while loading
17
17
  or if an error occurs.
@@ -8,7 +8,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:77](https://github.c
8
8
 
9
9
  ### config
10
10
 
11
- > `readonly` **config**: `null` \| `Readonly`\<`ConfigObject`\>
11
+ > `readonly` **config**: `null` \| `Readonly`\<[`ConfigObject`](ConfigObject.md)\>
12
12
 
13
13
  Defined in: [packages/framework/esm-extensions/src/store.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L83)
14
14
 
@@ -32,7 +32,7 @@ A callback to be called just before navigation occurs
32
32
 
33
33
  ### templateParams?
34
34
 
35
- > `optional` **templateParams**: `TemplateParams`
35
+ > `optional` **templateParams**: [`TemplateParams`](../type-aliases/TemplateParams.md)
36
36
 
37
37
  Defined in: [packages/framework/esm-react-utils/src/ConfigurableLink.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L39)
38
38
 
@@ -12,7 +12,7 @@ replaced with AssignedExtension
12
12
 
13
13
  ### ~~config~~
14
14
 
15
- > `readonly` **config**: `null` \| `Readonly`\<`ConfigObject`\>
15
+ > `readonly` **config**: `null` \| `Readonly`\<[`ConfigObject`](ConfigObject.md)\>
16
16
 
17
17
  Defined in: [packages/framework/esm-extensions/src/store.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L96)
18
18
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ConnectivityChangedEvent
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/events.d.ts:1
5
+ Defined in: [packages/framework/esm-globals/src/events.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,4 +10,4 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:1
10
10
 
11
11
  > **online**: `boolean`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/events.d.ts:2
13
+ Defined in: [packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L2)
@@ -4,9 +4,13 @@
4
4
 
5
5
  Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/diagnosis-resource.ts#L6)
6
6
 
7
+ Superclass for all Openmrs Resources, with strict typings.
8
+ If the subclass does not have all attributes (including optional ones)
9
+ accounted for, use OpenmrsResource instead.
10
+
7
11
  ## Extends
8
12
 
9
- - `OpenmrsResource`
13
+ - [`OpenmrsResource`](OpenmrsResource.md)
10
14
 
11
15
  ## Indexable
12
16
 
@@ -16,13 +20,13 @@ Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:6](h
16
20
 
17
21
  ### auditInfo?
18
22
 
19
- > `optional` **auditInfo**: `AuditInfo`
23
+ > `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
20
24
 
21
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
25
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
22
26
 
23
27
  #### Inherited from
24
28
 
25
- `OpenmrsResource.auditInfo`
29
+ [`OpenmrsResource`](OpenmrsResource.md).[`auditInfo`](OpenmrsResource.md#auditinfo)
26
30
 
27
31
  ***
28
32
 
@@ -46,11 +50,11 @@ Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:7](h
46
50
 
47
51
  ##### coded.conceptClass?
48
52
 
49
- > `optional` **conceptClass**: `ConceptClass`
53
+ > `optional` **conceptClass**: [`ConceptClass`](ConceptClass.md)
50
54
 
51
55
  ##### coded.datatype?
52
56
 
53
- > `optional` **datatype**: `OpenmrsResource`
57
+ > `optional` **datatype**: [`OpenmrsResource`](OpenmrsResource.md)
54
58
 
55
59
  ##### coded.display?
56
60
 
@@ -58,7 +62,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:7](h
58
62
 
59
63
  ##### coded.name?
60
64
 
61
- > `optional` **name**: `Concept`
65
+ > `optional` **name**: [`Concept`](Concept.md)
62
66
 
63
67
  ##### coded.uuid
64
68
 
@@ -74,11 +78,11 @@ Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:7](h
74
78
 
75
79
  > `optional` **display**: `string`
76
80
 
77
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
81
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
78
82
 
79
83
  #### Inherited from
80
84
 
81
- `OpenmrsResource.display`
85
+ [`OpenmrsResource`](OpenmrsResource.md).[`display`](OpenmrsResource.md#display)
82
86
 
83
87
  ***
84
88
 
@@ -108,13 +112,13 @@ Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:22](
108
112
 
109
113
  ### links?
110
114
 
111
- > `optional` **links**: `Link`[]
115
+ > `optional` **links**: [`Link`](Link.md)[]
112
116
 
113
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
117
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
114
118
 
115
119
  #### Inherited from
116
120
 
117
- `OpenmrsResource.links`
121
+ [`OpenmrsResource`](OpenmrsResource.md).[`links`](OpenmrsResource.md#links)
118
122
 
119
123
  ***
120
124
 
@@ -138,11 +142,11 @@ Defined in: [packages/framework/esm-emr-api/src/types/diagnosis-resource.ts:20](
138
142
 
139
143
  > `optional` **resourceVersion**: `string`
140
144
 
141
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
145
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
142
146
 
143
147
  #### Inherited from
144
148
 
145
- `OpenmrsResource.resourceVersion`
149
+ [`OpenmrsResource`](OpenmrsResource.md).[`resourceVersion`](OpenmrsResource.md#resourceversion)
146
150
 
147
151
  ***
148
152
 
@@ -150,11 +154,11 @@ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
150
154
 
151
155
  > **uuid**: `string`
152
156
 
153
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
157
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
154
158
 
155
159
  #### Inherited from
156
160
 
157
- `OpenmrsResource.uuid`
161
+ [`OpenmrsResource`](OpenmrsResource.md).[`uuid`](OpenmrsResource.md#uuid)
158
162
 
159
163
  ***
160
164
 
@@ -4,9 +4,13 @@
4
4
 
5
5
  Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L3)
6
6
 
7
+ Superclass for all Openmrs Resources, with strict typings.
8
+ If the subclass does not have all attributes (including optional ones)
9
+ accounted for, use OpenmrsResource instead.
10
+
7
11
  ## Extends
8
12
 
9
- - `OpenmrsResource`
13
+ - [`OpenmrsResource`](OpenmrsResource.md)
10
14
 
11
15
  ## Indexable
12
16
 
@@ -16,19 +20,19 @@ Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:3](https:
16
20
 
17
21
  ### auditInfo?
18
22
 
19
- > `optional` **auditInfo**: `AuditInfo`
23
+ > `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
20
24
 
21
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
25
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
22
26
 
23
27
  #### Inherited from
24
28
 
25
- `OpenmrsResource.auditInfo`
29
+ [`OpenmrsResource`](OpenmrsResource.md).[`auditInfo`](OpenmrsResource.md#auditinfo)
26
30
 
27
31
  ***
28
32
 
29
33
  ### concept
30
34
 
31
- > **concept**: `Concept`
35
+ > **concept**: [`Concept`](Concept.md)
32
36
 
33
37
  Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L6)
34
38
 
@@ -42,13 +46,13 @@ Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:8](https:
42
46
 
43
47
  #### Overrides
44
48
 
45
- `OpenmrsResource.display`
49
+ [`OpenmrsResource`](OpenmrsResource.md).[`display`](OpenmrsResource.md#display)
46
50
 
47
51
  ***
48
52
 
49
53
  ### dosageForm
50
54
 
51
- > **dosageForm**: `OpenmrsResource`
55
+ > **dosageForm**: [`OpenmrsResource`](OpenmrsResource.md)
52
56
 
53
57
  Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L7)
54
58
 
@@ -56,13 +60,13 @@ Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:7](https:
56
60
 
57
61
  ### links?
58
62
 
59
- > `optional` **links**: `Link`[]
63
+ > `optional` **links**: [`Link`](Link.md)[]
60
64
 
61
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
65
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
62
66
 
63
67
  #### Inherited from
64
68
 
65
- `OpenmrsResource.links`
69
+ [`OpenmrsResource`](OpenmrsResource.md).[`links`](OpenmrsResource.md#links)
66
70
 
67
71
  ***
68
72
 
@@ -70,11 +74,11 @@ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
70
74
 
71
75
  > `optional` **resourceVersion**: `string`
72
76
 
73
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
77
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
74
78
 
75
79
  #### Inherited from
76
80
 
77
- `OpenmrsResource.resourceVersion`
81
+ [`OpenmrsResource`](OpenmrsResource.md).[`resourceVersion`](OpenmrsResource.md#resourceversion)
78
82
 
79
83
  ***
80
84
 
@@ -94,4 +98,4 @@ Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:4](https:
94
98
 
95
99
  #### Overrides
96
100
 
97
- `OpenmrsResource.uuid`
101
+ [`OpenmrsResource`](OpenmrsResource.md).[`uuid`](OpenmrsResource.md#uuid)