@openmrs/esm-framework 8.0.1-pre.3585 → 8.0.1-pre.3600

package/docs/interfaces/Order.md

@@ -0,0 +1,461 @@
+[O3 Framework](../API.md) / Order
+
+# Interface: Order
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L17)
+
+## Extends
+
+- `OpenmrsResource`
+
+## Indexable
+
+\[`anythingElse`: `string`\]: `any`
+
+## Properties
+
+### accessionNumber
+
+> **accessionNumber**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L69)
+
+***
+
+### action
+
+> **action**: [`OrderAction`](../type-aliases/OrderAction.md)
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L19)
+
+***
+
+### asNeeded
+
+> **asNeeded**: `boolean`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L20)
+
+***
+
+### asNeededCondition?
+
+> `optional` **asNeededCondition**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L21)
+
+***
+
+### auditInfo?
+
+> `optional` **auditInfo**: `AuditInfo`
+
+Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
+
+#### Inherited from
+
+`OpenmrsResource.auditInfo`
+
+***
+
+### autoExpireDate
+
+> **autoExpireDate**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L22)
+
+***
+
+### brandName?
+
+> `optional` **brandName**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L23)
+
+***
+
+### careSetting
+
+> **careSetting**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L24)
+
+***
+
+### clinicalHistory
+
+> **clinicalHistory**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L76)
+
+***
+
+### commentToFulfiller
+
+> **commentToFulfiller**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L25)
+
+***
+
+### concept
+
+> **concept**: `Concept`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L26)
+
+***
+
+### dateActivated
+
+> **dateActivated**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L27)
+
+***
+
+### dateStopped?
+
+> `optional` **dateStopped**: `null` \| `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L28)
+
+***
+
+### dispenseAsWritten
+
+> **dispenseAsWritten**: `boolean`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L29)
+
+***
+
+### display
+
+> **display**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L71)
+
+#### Overrides
+
+`OpenmrsResource.display`
+
+***
+
+### dose
+
+> **dose**: `number`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L30)
+
+***
+
+### doseUnits
+
+> **doseUnits**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L31)
+
+***
+
+### dosingInstructions
+
+> **dosingInstructions**: `null` \| `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L32)
+
+***
+
+### dosingType?
+
+> `optional` **dosingType**: `"org.openmrs.FreeTextDosingInstructions"` \| `"org.openmrs.SimpleDosingInstructions"`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L33)
+
+***
+
+### drug
+
+> **drug**: [`Drug`](Drug.md)
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L34)
+
+***
+
+### duration
+
+> **duration**: `number`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L35)
+
+***
+
+### durationUnits
+
+> **durationUnits**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L36)
+
+***
+
+### encounter
+
+> **encounter**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L37)
+
+***
+
+### frequency
+
+> **frequency**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L38)
+
+***
+
+### fulfillerComment
+
+> **fulfillerComment**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L73)
+
+***
+
+### fulfillerStatus
+
+> **fulfillerStatus**: [`FulfillerStatus`](../type-aliases/FulfillerStatus.md)
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L72)
+
+***
+
+### instructions?
+
+> `optional` **instructions**: `null` \| `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L39)
+
+***
+
+### laterality
+
+> **laterality**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L75)
+
+***
+
+### links?
+
+> `optional` **links**: `Link`[]
+
+Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
+
+#### Inherited from
+
+`OpenmrsResource.links`
+
+***
+
+### numberOfRepeats
+
+> **numberOfRepeats**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L77)
+
+***
+
+### numRefills
+
+> **numRefills**: `number`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L40)
+
+***
+
+### orderer
+
+> **orderer**: `object`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L53)
+
+#### display
+
+> **display**: `string`
+
+#### person
+
+> **person**: `object`
+
+##### person.display
+
+> **display**: `string`
+
+#### uuid
+
+> **uuid**: `string`
+
+***
+
+### orderNumber
+
+> **orderNumber**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L41)
+
+***
+
+### orderReason
+
+> **orderReason**: `null` \| `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L42)
+
+***
+
+### orderReasonNonCoded
+
+> **orderReasonNonCoded**: `null` \| `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L43)
+
+***
+
+### orderType
+
+> **orderType**: `object`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L44)
+
+#### conceptClasses
+
+> **conceptClasses**: `any`[]
+
+#### description
+
+> **description**: `string`
+
+#### display
+
+> **display**: `string`
+
+#### name
+
+> **name**: `string`
+
+#### parent
+
+> **parent**: `null` \| `string`
+
+#### retired
+
+> **retired**: `boolean`
+
+#### uuid
+
+> **uuid**: `string`
+
+***
+
+### patient
+
+> **patient**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L60)
+
+***
+
+### previousOrder
+
+> **previousOrder**: `null` \| \{ `display`: `string`; `type`: `string`; `uuid`: `string`; \}
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L61)
+
+***
+
+### quantity
+
+> **quantity**: `number`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L62)
+
+***
+
+### quantityUnits
+
+> **quantityUnits**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L63)
+
+***
+
+### resourceVersion?
+
+> `optional` **resourceVersion**: `string`
+
+Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
+
+#### Inherited from
+
+`OpenmrsResource.resourceVersion`
+
+***
+
+### route
+
+> **route**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L64)
+
+***
+
+### scheduleDate
+
+> **scheduleDate**: `null`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L65)
+
+***
+
+### scheduledDate
+
+> **scheduledDate**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L70)
+
+***
+
+### specimenSource
+
+> **specimenSource**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L74)
+
+***
+
+### type
+
+> **type**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L78)
+
+***
+
+### urgency
+
+> **urgency**: [`OrderUrgency`](../type-aliases/OrderUrgency.md)
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L66)
+
+***
+
+### uuid
+
+> **uuid**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L18)
+
+#### Overrides
+
+`OpenmrsResource.uuid`

package/docs/interfaces/PaginationProps.md

@@ -0,0 +1,95 @@
+[O3 Framework](../API.md) / PaginationProps
+
+# Interface: PaginationProps
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L8)
+
+## Properties
+
+### currentItems
+
+> **currentItems**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L10)
+
+The count of current items displayed
+
+***
+
+### dashboardLinkLabel?
+
+> `optional` **dashboardLinkLabel**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L22)
+
+Optional text to display instead of the default "See all"
+
+***
+
+### dashboardLinkUrl?
+
+> `optional` **dashboardLinkUrl**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L20)
+
+An optional URL the user should be directed to if they click on the link to see all results
+
+***
+
+### onPageNumberChange()?
+
+> `optional` **onPageNumberChange**: (`data`) => `void`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L18)
+
+A callback to be called when the page changes
+
+#### Parameters
+
+##### data
+
+###### page
+
+`number`
+
+###### pageSize
+
+`number`
+
+###### ref?
+
+`RefObject`\<`any`\>
+
+#### Returns
+
+`void`
+
+***
+
+### pageNumber
+
+> **pageNumber**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L14)
+
+The current page number
+
+***
+
+### pageSize
+
+> **pageSize**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L16)
+
+The size of each page
+
+***
+
+### totalItems
+
+> **totalItems**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L12)
+
+The count of total items displayed

package/docs/type-aliases/ErrorCardProps.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ErrorCardProps
+
+# Type Alias: ErrorCardProps
+
+> **ErrorCardProps** = [`ErrorStateProps`](../interfaces/ErrorStateProps.md)
+
+Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L30)

package/docs/type-aliases/FulfillerStatus.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / FulfillerStatus
+
+# Type Alias: FulfillerStatus
+
+> **FulfillerStatus** = `"RECEIVED"` \| `"IN_PROGRESS"` \| `"EXCEPTION"` \| `"ON_HOLD"` \| `"DECLINED"` \| `"COMPLETED"` \| `"DISCONINTUED"`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L4)

package/docs/type-aliases/OrderAction.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / OrderAction
+
+# Type Alias: OrderAction
+
+> **OrderAction** = `"NEW"` \| `"REVISE"` \| `"DISCONTINUE"` \| `"RENEW"`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L13)

package/docs/type-aliases/OrderUrgency.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / OrderUrgency
+
+# Type Alias: OrderUrgency
+
+> **OrderUrgency** = `"ROUTINE"` \| `"STAT"` \| `"ON_SCHEDULED_DATE"`
+
+Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L15)

package/docs/variables/EmptyCard.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / EmptyCard
+
+# Variable: EmptyCard
+
+> `const` **EmptyCard**: `React.FC`\<[`EmptyCardProps`](../interfaces/EmptyCardProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L29)
+
+Re-usable card for displaying an empty state

package/docs/variables/ErrorCard.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ErrorCard
+
+# Variable: ErrorCard
+
+> `const` **ErrorCard**: `FC`\<[`ErrorStateProps`](../interfaces/ErrorStateProps.md)\> = `ErrorState`
+
+Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L29)

package/docs/variables/ErrorState.md

@@ -4,4 +4,4 @@
 
 > `const` **ErrorState**: `React.FC`\<[`ErrorStateProps`](../interfaces/ErrorStateProps.md)\>
 
-Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L12)
+Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L14)

package/docs/variables/Pagination.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / Pagination
+
+# Variable: Pagination
+
+> `const` **Pagination**: `React.FC`\<[`PaginationProps`](../interfaces/PaginationProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L28)
+
+Re-usable pagination bar