@openmrs/esm-api 3.1.15-pre.692 → 3.1.15-pre.707

package/docs/API.md

@@ -1,724 +0,0 @@
-[Back to README.md](../README.md)
-
-# @openmrs/esm-api
-
-## Table of contents
-
-### Enumerations
-
-- [VisitMode](enums/VisitMode.md)
-- [VisitStatus](enums/VisitStatus.md)
-
-### Classes
-
-- [OpenmrsFetchError](classes/OpenmrsFetchError.md)
-
-### Interfaces
-
-- [CurrentPatientOptions](interfaces/CurrentPatientOptions.md)
-- [CurrentUserOptions](interfaces/CurrentUserOptions.md)
-- [CurrentUserWithResponseOption](interfaces/CurrentUserWithResponseOption.md)
-- [CurrentUserWithoutResponseOption](interfaces/CurrentUserWithoutResponseOption.md)
-- [FHIRCode](interfaces/FHIRCode.md)
-- [FHIRRequestObj](interfaces/FHIRRequestObj.md)
-- [FHIRResource](interfaces/FHIRResource.md)
-- [FetchHeaders](interfaces/FetchHeaders.md)
-- [FetchResponse](interfaces/FetchResponse.md)
-- [Location](interfaces/Location.md)
-- [LoggedInUser](interfaces/LoggedInUser.md)
-- [LoggedInUserFetchResponse](interfaces/LoggedInUserFetchResponse.md)
-- [NewVisitPayload](interfaces/NewVisitPayload.md)
-- [OnlyThePatient](interfaces/OnlyThePatient.md)
-- [OpenmrsResource](interfaces/OpenmrsResource.md)
-- [PatientWithFullResponse](interfaces/PatientWithFullResponse.md)
-- [Person](interfaces/Person.md)
-- [Privilege](interfaces/Privilege.md)
-- [Role](interfaces/Role.md)
-- [SessionLocation](interfaces/SessionLocation.md)
-- [SessionUser](interfaces/SessionUser.md)
-- [UnauthenticatedUser](interfaces/UnauthenticatedUser.md)
-- [User](interfaces/User.md)
-- [Visit](interfaces/Visit.md)
-- [VisitItem](interfaces/VisitItem.md)
-- [VisitType](interfaces/VisitType.md)
-- [WorkspaceItem](interfaces/WorkspaceItem.md)
-
-### Type aliases
-
-- [CurrentPatient](API.md#currentpatient)
-- [LoggedInUserData](API.md#loggedinuserdata)
-- [PatientUuid](API.md#patientuuid)
-- [UpdateVisitPayload](API.md#updatevisitpayload)
-
-### API Variables
-
-- [fhir](API.md#fhir)
-
-### Other Variables
-
-- [backendDependencies](API.md#backenddependencies)
-- [fhirBaseUrl](API.md#fhirbaseurl)
-- [getStartedVisit](API.md#getstartedvisit)
-- [sessionEndpoint](API.md#sessionendpoint)
-
-### API Functions
-
-- [openmrsFetch](API.md#openmrsfetch)
-- [openmrsObservableFetch](API.md#openmrsobservablefetch)
-
-### API Object Functions
-
-- [fetchCurrentPatient](API.md#fetchcurrentpatient)
-- [getCurrentUser](API.md#getcurrentuser)
-- [refetchCurrentUser](API.md#refetchcurrentuser)
-
-### Other Functions
-
-- [getLocations](API.md#getlocations)
-- [getLoggedInUser](API.md#getloggedinuser)
-- [getSessionLocation](API.md#getsessionlocation)
-- [getVisitTypes](API.md#getvisittypes)
-- [getVisitsForPatient](API.md#getvisitsforpatient)
-- [makeUrl](API.md#makeurl)
-- [openVisitsNoteWorkspace](API.md#openvisitsnoteworkspace)
-- [saveVisit](API.md#savevisit)
-- [setSessionLocation](API.md#setsessionlocation)
-- [toLocationObject](API.md#tolocationobject)
-- [toVisitTypeObject](API.md#tovisittypeobject)
-- [updateVisit](API.md#updatevisit)
-- [userHasAccess](API.md#userhasaccess)
-
-### Workspace Functions
-
-- [getNewWorkspaceItem](API.md#getnewworkspaceitem)
-- [newWorkspaceItem](API.md#newworkspaceitem)
-
-## Type aliases
-
-### CurrentPatient
-
-Ƭ **CurrentPatient**: `fhir.Patient` \| [`FetchResponse`](interfaces/FetchResponse.md)<`fhir.Patient`\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L4)
-
-___
-
-### LoggedInUserData
-
-Ƭ **LoggedInUserData**: [`UnauthenticatedUser`](interfaces/UnauthenticatedUser.md) & { `user?`: [`LoggedInUser`](interfaces/LoggedInUser.md)  }
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/fetch.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fetch.ts#L7)
-
-___
-
-### PatientUuid
-
-Ƭ **PatientUuid**: `string` \| ``null``
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L18)
-
-___
-
-### UpdateVisitPayload
-
-Ƭ **UpdateVisitPayload**: [`NewVisitPayload`](interfaces/NewVisitPayload.md) & {}
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/visit-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L12)
-
-## API Variables
-
-### fhir
-
-• `Const` **fhir**: `FhirClient`
-
-The `fhir` object is [an instance of fhir.js](https://github.com/FHIR/fhir.js)
-that can be used to call FHIR-compliant OpenMRS APIs. See
-[the docs for fhir.js](https://github.com/FHIR/fhir.js) for more info
-and example usage.
-
-#### Defined in
-
-[packages/framework/esm-api/src/fhir.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L41)
-
-___
-
-## Other Variables
-
-### backendDependencies
-
-• `Const` **backendDependencies**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `fhir2` | `string` |
-| `webservices.rest` | `string` |
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-backend-dependencies.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-backend-dependencies.ts#L1)
-
-___
-
-### fhirBaseUrl
-
-• `Const` **fhirBaseUrl**: ``"/ws/fhir2/R4"``
-
-#### Defined in
-
-[packages/framework/esm-api/src/fhir.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L4)
-
-___
-
-### getStartedVisit
-
-• `Const` **getStartedVisit**: `BehaviorSubject`<``null`` \| [`VisitItem`](interfaces/VisitItem.md)\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L84)
-
-___
-
-### sessionEndpoint
-
-• `Const` **sessionEndpoint**: ``"/ws/rest/v1/session"``
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-fetch.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L6)
-
-## API Functions
-
-### openmrsFetch
-
-▸ **openmrsFetch**<`T`\>(`path`, `fetchInit?`): `Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
-
-The openmrsFetch function is a wrapper around the
-[browser's built-in fetch function](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch),
-with extra handling for OpenMRS-specific API behaviors, such as
-request headers, authentication, authorization, and the API urls.
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `path` | `string` | A string url to make the request to. Note that the   openmrs base url (by default `/openmrs`) will be automatically   prepended to the URL, so there is no need to include it. |
-| `fetchInit` | `FetchConfig` | A [fetch init object](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Syntax).   Note that the `body` property does not need to be `JSON.stringify()`ed   because openmrsFetch will do that for you. |
-
-#### Returns
-
-`Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
-
-A [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
-  that resolves with a [Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response).
-  Note that the openmrs version of the Response object has already
-  downloaded the HTTP response body as json, and has an additional
-  `data` property with the HTTP response json as a javascript object.
-
-#### Example
-```js
-import { openmrsFetch } from '@openmrs/esm-api'
-const abortController = new AbortController();
-openmrsFetch('/ws/rest/v1/session', {signal: abortController.signal})
-  .then(response => {
-    console.log(response.data.authenticated)
-  })
-  .catch(err => {
-    console.error(err.status);
-  })
-abortController.abort();
-openmrsFetch('/ws/rest/v1/session', {
-  method: 'POST',
-  body: {
-    username: 'hi',
-    password: 'there',
-  }
-})
-```
-
-#### Cancellation
-
-To cancel a network request, use an
-[AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort).
-It is best practice to cancel your network requests when the user
-navigates away from a page while the request is pending request, to
-free up memory and network resources and to prevent race conditions.
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-fetch.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L61)
-
-___
-
-### openmrsObservableFetch
-
-▸ **openmrsObservableFetch**<`T`\>(`url`, `fetchInit?`): `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
-
-The openmrsObservableFetch function is a wrapper around openmrsFetch
-that returns an [Observable](https://rxjs-dev.firebaseapp.com/guide/observable)
-instead of a promise. It exists in case using an Observable is
-preferred or more convenient than a promise.
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `url` | `string` | See [openmrsFetch](API.md#openmrsfetch) |
-| `fetchInit` | `FetchConfig` | See [openmrsFetch](API.md#openmrsfetch) |
-
-#### Returns
-
-`Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
-
-An Observable that produces exactly one Response object.
-The response object is exactly the same as for [openmrsFetch](API.md#openmrsfetch).
-
-#### Example
-
-```js
-import { openmrsObservableFetch } from '@openmrs/esm-api'
-const subscription = openmrsObservableFetch('/ws/rest/v1/session').subscribe(
-  response => console.log(response.data),
-  err => {throw err},
-  () => console.log('finished')
-)
-subscription.unsubscribe()
-```
-
-#### Cancellation
-
-To cancel the network request, simply call `subscription.unsubscribe();`
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-fetch.ts:232](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L232)
-
-___
-
-## API Object Functions
-
-### fetchCurrentPatient
-
-▸ **fetchCurrentPatient**(`patientUuid`, `contentOverrides?`): `Promise`<`Object`\> \| `Promise`<``null``\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `patientUuid` | [`PatientUuid`](API.md#patientuuid) |
-| `contentOverrides?` | `Partial`<`Parameters`<typeof `fhir.read`\>[``0``]\> |
-
-#### Returns
-
-`Promise`<`Object`\> \| `Promise`<``null``\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L23)
-
-___
-
-### getCurrentUser
-
-▸ **getCurrentUser**(): `Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
-
-The getCurrentUser function returns an observable that produces
-**zero or more values, over time**. It will produce zero values
-by default if the user is not logged in. And it will provide a
-first value when the logged in user is fetched from the server.
-Subsequent values will be produced whenever the user object is
-updated.
-
-#### Returns
-
-`Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
-
-An Observable that produces zero or more values (as
-  described above). The values produced will be a user object (if
-  `includeAuthStatus` is set to `false`) or an object with a session
-  and authenticated property (if `includeAuthStatus` is set to `true`).
-
-#### Example
-
-```js
-import { getCurrentUser } from '@openmrs/esm-api'
-const subscription = getCurrentUser().subscribe(
-  user => console.log(user)
-)
-subscription.unsubscribe()
-getCurrentUser({includeAuthStatus: true}).subscribe(
-  data => console.log(data.authenticated)
-)
-```
-
-#### Be sure to unsubscribe when your component unmounts
-
-Otherwise your code will continue getting updates to the user object
-even after the UI component is gone from the screen. This is a memory
-leak and source of bugs.
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L57)
-
-▸ **getCurrentUser**(`opts`): `Observable`<[`UnauthenticatedUser`](interfaces/UnauthenticatedUser.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `opts` | [`CurrentUserWithResponseOption`](interfaces/CurrentUserWithResponseOption.md) |
-
-#### Returns
-
-`Observable`<[`UnauthenticatedUser`](interfaces/UnauthenticatedUser.md)\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L58)
-
-▸ **getCurrentUser**(`opts`): `Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `opts` | [`CurrentUserWithoutResponseOption`](interfaces/CurrentUserWithoutResponseOption.md) |
-
-#### Returns
-
-`Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L61)
-
-___
-
-### refetchCurrentUser
-
-▸ **refetchCurrentUser**(): `void`
-
-The `refetchCurrentUser` function causes a network request to redownload
-the user. All subscribers to the current user will be notified of the
-new users once the new version of the user object is downloaded.
-
-#### Returns
-
-`void`
-
-The same observable as returned by [getCurrentUser](API.md#getcurrentuser).
-
-#### Example
-```js
-import { refetchCurrentUser } from '@openmrs/esm-api'
-refetchCurrentUser()
-```
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L116)
-
-___
-
-## Other Functions
-
-### getLocations
-
-▸ **getLocations**(): `Observable`<[`Location`](interfaces/Location.md)[]\>
-
-#### Returns
-
-`Observable`<[`Location`](interfaces/Location.md)[]\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/location.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/location.ts#L13)
-
-___
-
-### getLoggedInUser
-
-▸ **getLoggedInUser**(): `Promise`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
-
-#### Returns
-
-`Promise`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:134](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L134)
-
-___
-
-### getSessionLocation
-
-▸ **getSessionLocation**(): `Promise`<`undefined` \| [`SessionLocation`](interfaces/SessionLocation.md)\>
-
-#### Returns
-
-`Promise`<`undefined` \| [`SessionLocation`](interfaces/SessionLocation.md)\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:143](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L143)
-
-___
-
-### getVisitTypes
-
-▸ **getVisitTypes**(): `Observable`<[`VisitType`](interfaces/VisitType.md)[]\>
-
-#### Returns
-
-`Observable`<[`VisitType`](interfaces/VisitType.md)[]\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-type.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L14)
-
-___
-
-### getVisitsForPatient
-
-▸ **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`Object`\>\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `patientUuid` | `string` |
-| `abortController` | `AbortController` |
-| `v?` | `string` |
-
-#### Returns
-
-`Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`Object`\>\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L23)
-
-___
-
-### makeUrl
-
-▸ **makeUrl**(`path`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-fetch.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L8)
-
-___
-
-### openVisitsNoteWorkspace
-
-▸ **openVisitsNoteWorkspace**(`componentName`, `title`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `componentName` | `string` |
-| `title` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L12)
-
-___
-
-### saveVisit
-
-▸ **saveVisit**(`payload`, `abortController`): `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`any`\>\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `payload` | [`NewVisitPayload`](interfaces/NewVisitPayload.md) |
-| `abortController` | `AbortController` |
-
-#### Returns
-
-`Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`any`\>\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L55)
-
-___
-
-### setSessionLocation
-
-▸ **setSessionLocation**(`locationUuid`, `abortController`): `Promise`<`any`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `locationUuid` | `string` |
-| `abortController` | `AbortController` |
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:155](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L155)
-
-___
-
-### toLocationObject
-
-▸ **toLocationObject**(`openmrsRestForm`): [`Location`](interfaces/Location.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `openmrsRestForm` | `any` |
-
-#### Returns
-
-[`Location`](interfaces/Location.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/location.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/location.ts#L6)
-
-___
-
-### toVisitTypeObject
-
-▸ **toVisitTypeObject**(`openmrsRestForm`): [`VisitType`](interfaces/VisitType.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `openmrsRestForm` | `any` |
-
-#### Returns
-
-[`VisitType`](interfaces/VisitType.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-type.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L6)
-
-___
-
-### updateVisit
-
-▸ **updateVisit**(`uuid`, `payload`, `abortController`): `Observable`<`any`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `uuid` | `string` |
-| `payload` | [`UpdateVisitPayload`](API.md#updatevisitpayload) |
-| `abortController` | `AbortController` |
-
-#### Returns
-
-`Observable`<`any`\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L69)
-
-___
-
-### userHasAccess
-
-▸ **userHasAccess**(`requiredPrivilege`, `user`): `undefined` \| [`Privilege`](interfaces/Privilege.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `requiredPrivilege` | `string` |
-| `user` | [`LoggedInUser`](interfaces/LoggedInUser.md) |
-
-#### Returns
-
-`undefined` \| [`Privilege`](interfaces/Privilege.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-user.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L130)
-
-___
-
-## Workspace Functions
-
-### getNewWorkspaceItem
-
-▸ **getNewWorkspaceItem**(): `Observable`<[`WorkspaceItem`](interfaces/WorkspaceItem.md)\>
-
-#### Returns
-
-`Observable`<[`WorkspaceItem`](interfaces/WorkspaceItem.md)\>
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L19)
-
-___
-
-### newWorkspaceItem
-
-▸ **newWorkspaceItem**(`item`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `item` | [`WorkspaceItem`](interfaces/WorkspaceItem.md) |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L10)