@openmrs/esm-api 3.1.15-pre.693 → 3.1.15-pre.709

package/docs/classes/OpenmrsFetchError.md

@@ -1,186 +0,0 @@
-[@openmrs/esm-api](../API.md) / OpenmrsFetchError
-
-# Class: OpenmrsFetchError
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`OpenmrsFetchError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](OpenmrsFetchError.md#constructor)
-
-### Properties
-
-- [message](OpenmrsFetchError.md#message)
-- [name](OpenmrsFetchError.md#name)
-- [response](OpenmrsFetchError.md#response)
-- [responseBody](OpenmrsFetchError.md#responsebody)
-- [stack](OpenmrsFetchError.md#stack)
-- [prepareStackTrace](OpenmrsFetchError.md#preparestacktrace)
-- [stackTraceLimit](OpenmrsFetchError.md#stacktracelimit)
-
-### Methods
-
-- [captureStackTrace](OpenmrsFetchError.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new OpenmrsFetchError**(`url`, `response`, `responseBody`, `requestStacktrace`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `response` | `Response` |
-| `responseBody` | ``null`` \| `ResponseBody` |
-| `requestStacktrace` | `Error` |
-
-#### Overrides
-
-Error.constructor
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-fetch.ts:270](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L270)
-
-## Properties
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-Error.message
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1023
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-Error.name
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1022
-
-___
-
-### response
-
-• **response**: `Response`
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-fetch.ts:283](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L283)
-
-___
-
-### responseBody
-
-• **responseBody**: ``null`` \| `string` \| `FetchResponseJson`
-
-#### Defined in
-
-[packages/framework/esm-api/src/openmrs-fetch.ts:284](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L284)
-
-___
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-Error.stack
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1024
-
-___
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-Optional override for formatting stack traces
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-#### Inherited from
-
-Error.prepareStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:11
-
-___
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:13
-
-## Methods
-
-### captureStackTrace
-
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Error.captureStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:4

package/docs/enums/VisitMode.md

@@ -1,41 +0,0 @@
-[@openmrs/esm-api](../API.md) / VisitMode
-
-# Enumeration: VisitMode
-
-## Table of contents
-
-### Enumeration members
-
-- [EDITVISIT](VisitMode.md#editvisit)
-- [LOADING](VisitMode.md#loading)
-- [NEWVISIT](VisitMode.md#newvisit)
-
-## Enumeration members
-
-### EDITVISIT
-
-• **EDITVISIT** = `"editVisit"`
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L95)
-
-___
-
-### LOADING
-
-• **LOADING** = `"loadingVisit"`
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L96)
-
-___
-
-### NEWVISIT
-
-• **NEWVISIT** = `"startVisit"`
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:94](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L94)

package/docs/enums/VisitStatus.md

@@ -1,30 +0,0 @@
-[@openmrs/esm-api](../API.md) / VisitStatus
-
-# Enumeration: VisitStatus
-
-## Table of contents
-
-### Enumeration members
-
-- [NOTSTARTED](VisitStatus.md#notstarted)
-- [ONGOING](VisitStatus.md#ongoing)
-
-## Enumeration members
-
-### NOTSTARTED
-
-• **NOTSTARTED** = `"notStarted"`
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:100](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L100)
-
-___
-
-### ONGOING
-
-• **ONGOING** = `"ongoing"`
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:101](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L101)

package/docs/interfaces/CurrentPatientOptions.md

@@ -1,27 +0,0 @@
-[@openmrs/esm-api](../API.md) / CurrentPatientOptions
-
-# Interface: CurrentPatientOptions
-
-## Hierarchy
-
-- **`CurrentPatientOptions`**
-
-  ↳ [`PatientWithFullResponse`](PatientWithFullResponse.md)
-
-  ↳ [`OnlyThePatient`](OnlyThePatient.md)
-
-## Table of contents
-
-### Properties
-
-- [includeConfig](CurrentPatientOptions.md#includeconfig)
-
-## Properties
-
-### includeConfig
-
-• `Optional` **includeConfig**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L7)

package/docs/interfaces/CurrentUserOptions.md

@@ -1,27 +0,0 @@
-[@openmrs/esm-api](../API.md) / CurrentUserOptions
-
-# Interface: CurrentUserOptions
-
-## Hierarchy
-
-- **`CurrentUserOptions`**
-
-  ↳ [`CurrentUserWithResponseOption`](CurrentUserWithResponseOption.md)
-
-  ↳ [`CurrentUserWithoutResponseOption`](CurrentUserWithoutResponseOption.md)
-
-## Table of contents
-
-### Properties
-
-- [includeAuthStatus](CurrentUserOptions.md#includeauthstatus)
-
-## Properties
-
-### includeAuthStatus
-
-• `Optional` **includeAuthStatus**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L2)

package/docs/interfaces/CurrentUserWithResponseOption.md

@@ -1,29 +0,0 @@
-[@openmrs/esm-api](../API.md) / CurrentUserWithResponseOption
-
-# Interface: CurrentUserWithResponseOption
-
-## Hierarchy
-
-- [`CurrentUserOptions`](CurrentUserOptions.md)
-
-  ↳ **`CurrentUserWithResponseOption`**
-
-## Table of contents
-
-### Properties
-
-- [includeAuthStatus](CurrentUserWithResponseOption.md#includeauthstatus)
-
-## Properties
-
-### includeAuthStatus
-
-• **includeAuthStatus**: ``true``
-
-#### Overrides
-
-[CurrentUserOptions](CurrentUserOptions.md).[includeAuthStatus](CurrentUserOptions.md#includeauthstatus)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L6)

package/docs/interfaces/CurrentUserWithoutResponseOption.md

@@ -1,29 +0,0 @@
-[@openmrs/esm-api](../API.md) / CurrentUserWithoutResponseOption
-
-# Interface: CurrentUserWithoutResponseOption
-
-## Hierarchy
-
-- [`CurrentUserOptions`](CurrentUserOptions.md)
-
-  ↳ **`CurrentUserWithoutResponseOption`**
-
-## Table of contents
-
-### Properties
-
-- [includeAuthStatus](CurrentUserWithoutResponseOption.md#includeauthstatus)
-
-## Properties
-
-### includeAuthStatus
-
-• **includeAuthStatus**: ``false``
-
-#### Overrides
-
-[CurrentUserOptions](CurrentUserOptions.md).[includeAuthStatus](CurrentUserOptions.md#includeauthstatus)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L10)

package/docs/interfaces/FHIRCode.md

@@ -1,30 +0,0 @@
-[@openmrs/esm-api](../API.md) / FHIRCode
-
-# Interface: FHIRCode
-
-## Table of contents
-
-### Properties
-
-- [code](FHIRCode.md#code)
-- [system](FHIRCode.md#system)
-
-## Properties
-
-### code
-
-• **code**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/fhir-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fhir-resource.ts#L27)
-
-___
-
-### system
-
-• **system**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/fhir-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fhir-resource.ts#L28)

package/docs/interfaces/FHIRRequestObj.md

@@ -1,41 +0,0 @@
-[@openmrs/esm-api](../API.md) / FHIRRequestObj
-
-# Interface: FHIRRequestObj
-
-## Table of contents
-
-### Properties
-
-- [headers](FHIRRequestObj.md#headers)
-- [method](FHIRRequestObj.md#method)
-- [url](FHIRRequestObj.md#url)
-
-## Properties
-
-### headers
-
-• **headers**: [`FetchHeaders`](FetchHeaders.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/fhir.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L49)
-
-___
-
-### method
-
-• **method**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/fhir.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L48)
-
-___
-
-### url
-
-• **url**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/fhir.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L47)

package/docs/interfaces/FHIRResource.md

@@ -1,46 +0,0 @@
-[@openmrs/esm-api](../API.md) / FHIRResource
-
-# Interface: FHIRResource
-
-## Table of contents
-
-### Properties
-
-- [resource](FHIRResource.md#resource)
-
-## Properties
-
-### resource
-
-• **resource**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `code` | `Object` |
-| `code.coding` | [`FHIRCode`](FHIRCode.md)[] |
-| `effectiveDateTime` | `Date` |
-| `encounter` | `Object` |
-| `encounter.reference` | `string` |
-| `encounter.type` | `string` |
-| `id` | `string` |
-| `issued` | `Date` |
-| `referenceRange` | `any` |
-| `resourceType` | `string` |
-| `status` | `string` |
-| `subject` | `Object` |
-| `subject.display` | `string` |
-| `subject.identifier` | `Object` |
-| `subject.identifier.id` | `string` |
-| `subject.identifier.system` | `string` |
-| `subject.identifier.use` | `string` |
-| `subject.identifier.value` | `string` |
-| `subject.reference` | `string` |
-| `subject.type` | `string` |
-| `valueQuantity` | `Object` |
-| `valueQuantity.value` | `number` |
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/fhir-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fhir-resource.ts#L2)

package/docs/interfaces/FetchHeaders.md

@@ -1,7 +0,0 @@
-[@openmrs/esm-api](../API.md) / FetchHeaders
-
-# Interface: FetchHeaders
-
-## Indexable
-
-▪ [key: `string`]: `string` \| ``null``