@openmrs/esm-framework 5.6.1-pre.1809 → 5.6.1-pre.1812

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
-@openmrs/esm-framework:build: cache hit, replaying output 03ce621a54cd9b4f
+@openmrs/esm-framework:build: cache hit, replaying output 5235ce82905bc8f7
 @openmrs/esm-framework:build: assets by chunk 244 KiB (id hint: vendors)
 @openmrs/esm-framework:build:   asset 788.openmrs-esm-framework.js 130 KiB [emitted] [minimized] (id hint: vendors) 2 related assets
 @openmrs/esm-framework:build:   asset 278.openmrs-esm-framework.js 53.9 KiB [emitted] [minimized] (id hint: vendors) 1 related asset
@@ -9,7 +9,7 @@
 @openmrs/esm-framework:build: asset 619.openmrs-esm-framework.js 18.8 KiB [emitted] [minimized] 1 related asset
 @openmrs/esm-framework:build: asset 735.openmrs-esm-framework.js 6.54 KiB [emitted] [minimized] 2 related assets
 @openmrs/esm-framework:build: asset 530.openmrs-esm-framework.js 6.4 KiB [emitted] [minimized] 1 related asset
-@openmrs/esm-framework:build: orphan modules 6.93 MiB [orphan] 1790 modules
+@openmrs/esm-framework:build: orphan modules 6.93 MiB [orphan] 1789 modules
 @openmrs/esm-framework:build: runtime modules 20 KiB 14 modules
 @openmrs/esm-framework:build: built modules 6.79 MiB (javascript) 336 bytes (share-init) 336 bytes (consume-shared) [built] 347 modules
 @openmrs/esm-framework:build: 
@@ -27,4 +27,4 @@
 @openmrs/esm-framework:build:       openmrs-esm-framework.js
 @openmrs/esm-framework:build: 
 @openmrs/esm-framework:build: 
-@openmrs/esm-framework:build: webpack 5.88.0 compiled with 3 warnings in 25910 ms
+@openmrs/esm-framework:build: webpack 5.88.0 compiled with 3 warnings in 26213 ms

package/docs/API.md

@@ -77,6 +77,7 @@
 
 ### Date and Time Functions
 
+- [convertToLocaleCalendar](API.md#converttolocalecalendar)
 - [formatDate](API.md#formatdate)
 - [formatDatetime](API.md#formatdatetime)
 - [formatTime](API.md#formattime)
@@ -225,10 +226,13 @@
 - [age](API.md#age)
 - [canAccessStorage](API.md#canaccessstorage)
 - [daysIntoYear](API.md#daysintoyear)
+- [displayName](API.md#displayname)
+- [formattedName](API.md#formattedname)
 - [getDefaultsFromConfigSchema](API.md#getdefaultsfromconfigschema)
 - [isSameDay](API.md#issameday)
 - [isVersionSatisfied](API.md#isversionsatisfied)
 - [retry](API.md#retry)
+- [selectPreferredName](API.md#selectpreferredname)
 - [shallowEqual](API.md#shallowequal)
 - [useAbortController](API.md#useabortcontroller)
 - [useDebounce](API.md#usedebounce)
@@ -360,7 +364,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L19)
+[packages/framework/esm-utils/src/omrs-dates.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L20)
 
 ___
 
@@ -370,7 +374,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L133)
+[packages/framework/esm-utils/src/omrs-dates.ts:134](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L134)
 
 ___
 
@@ -391,7 +395,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:135](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L135)
+[packages/framework/esm-utils/src/omrs-dates.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L136)
 
 ___
 
@@ -537,6 +541,16 @@ A definition of a modal as extracted from an app's routes.json
 
 ___
 
+### NameUse
+
+Ƭ **NameUse**: ``"usual"`` \| ``"official"`` \| ``"temp"`` \| ``"nickname"`` \| ``"anonymous"`` \| ``"old"`` \| ``"maiden"``
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:362](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L362)
+
+___
+
 ### OpenmrsRoutes
 
 Ƭ **OpenmrsRoutes**: `Record`<`string`, [`OpenmrsAppRoutes`](interfaces/OpenmrsAppRoutes.md)\>
@@ -2585,6 +2599,31 @@ ___
 
 ## Date and Time Functions
 
+### convertToLocaleCalendar
+
+▸ **convertToLocaleCalendar**(`date`, `locale`): `CalendarDate`
+
+Converts a calendar date to the equivalent locale calendar date.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `date` | `CalendarDate` |
+| `locale` | `string` \| `Locale` |
+
+#### Returns
+
+`CalendarDate`
+
+CalendarDate
+
+#### Defined in
+
+[packages/framework/esm-utils/src/omrs-dates.ts:387](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L387)
+
+___
+
 ### formatDate
 
 ▸ **formatDate**(`date`, `options?`): `string`
@@ -2619,7 +2658,7 @@ locales.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L261)
+[packages/framework/esm-utils/src/omrs-dates.ts:262](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L262)
 
 ___
 
@@ -2648,7 +2687,7 @@ output of `Date.prototype.toLocaleString` for *most* locales.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:363](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L363)
+[packages/framework/esm-utils/src/omrs-dates.ts:364](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L364)
 
 ___
 
@@ -2671,7 +2710,7 @@ Formats the input as a time, according to the current locale.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L347)
+[packages/framework/esm-utils/src/omrs-dates.ts:348](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L348)
 
 ___
 
@@ -2693,7 +2732,7 @@ Retrieves the default calendar for the specified locale if any.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:236](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L236)
+[packages/framework/esm-utils/src/omrs-dates.ts:237](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L237)
 
 ___
 
@@ -2711,7 +2750,7 @@ string
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:371](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L371)
+[packages/framework/esm-utils/src/omrs-dates.ts:372](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L372)
 
 ___
 
@@ -2734,7 +2773,7 @@ The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L27)
+[packages/framework/esm-utils/src/omrs-dates.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L28)
 
 ___
 
@@ -2754,7 +2793,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L56)
+[packages/framework/esm-utils/src/omrs-dates.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L57)
 
 ___
 
@@ -2777,7 +2816,7 @@ Uses `dayjs(dateString)`.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L129)
+[packages/framework/esm-utils/src/omrs-dates.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L130)
 
 ___
 
@@ -2805,7 +2844,7 @@ registerDefaultCalendar('en', 'buddhist') // sets the default calendar for the '
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:227](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L227)
+[packages/framework/esm-utils/src/omrs-dates.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L228)
 
 ___
 
@@ -2828,7 +2867,7 @@ Otherwise returns null.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L64)
+[packages/framework/esm-utils/src/omrs-dates.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L65)
 
 ___
 
@@ -2852,7 +2891,7 @@ Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:121](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L121)
+[packages/framework/esm-utils/src/omrs-dates.ts:122](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L122)
 
 ___
 
@@ -2875,7 +2914,7 @@ Formats the input as a date string using the format "DD - MMM - YYYY".
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L105)
+[packages/framework/esm-utils/src/omrs-dates.ts:106](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L106)
 
 ___
 
@@ -2898,7 +2937,7 @@ Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L75)
+[packages/framework/esm-utils/src/omrs-dates.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L76)
 
 ___
 
@@ -2921,7 +2960,7 @@ Formats the input as a time string using the format "HH:mm A".
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:97](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L97)
+[packages/framework/esm-utils/src/omrs-dates.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L98)
 
 ___
 
@@ -2944,7 +2983,7 @@ Formats the input as a time string using the format "HH:mm".
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L89)
+[packages/framework/esm-utils/src/omrs-dates.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L90)
 
 ___
 
@@ -2967,7 +3006,7 @@ Formats the input as a date string using the format "DD-MMM".
 
 #### Defined in
 
-[packages/framework/esm-utils/src/omrs-dates.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L113)
+[packages/framework/esm-utils/src/omrs-dates.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L114)
 
 ___
 
@@ -5058,7 +5097,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-contact-details.component.tsx:177](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-contact-details.component.tsx#L177)
+[packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-contact-details.component.tsx:171](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-contact-details.component.tsx#L171)
 
 ___
 
@@ -5611,6 +5650,57 @@ The number of days.
 
 ___
 
+### displayName
+
+▸ **displayName**(`patient`): `string`
+
+Gets the formatted display name for a patient.
+
+The display name will be taken from the patient's 'usual' name,
+or may fall back to the patient's 'official' name.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `patient` | `Patient` | The patient details in FHIR format. |
+
+#### Returns
+
+`string`
+
+The patient's display name or an empty string if name is not present.
+
+#### Defined in
+
+[packages/framework/esm-utils/src/patient-helpers.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/patient-helpers.ts#L14)
+
+___
+
+### formattedName
+
+▸ **formattedName**(`name`): `string`
+
+Get a formatted display string for an FHIR name.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `name` | `undefined` \| `HumanName` | The name to be formatted. |
+
+#### Returns
+
+`string`
+
+The formatted display name or an empty string if name is undefined.
+
+#### Defined in
+
+[packages/framework/esm-utils/src/patient-helpers.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/patient-helpers.ts#L24)
+
+___
+
 ### getDefaultsFromConfigSchema
 
 ▸ **getDefaultsFromConfigSchema**(`schema`): `Object`
@@ -5724,6 +5814,44 @@ The result of successfully executing `fn`.
 
 ___
 
+### selectPreferredName
+
+▸ **selectPreferredName**(`patient`, ...`preferredNames`): `fhir.HumanName` \| `undefined`
+
+Select the preferred name from the collection of names associated with a patient.
+
+Names may be specified with a usage such as 'usual', 'official', 'nickname', 'maiden', etc.
+A name with no usage specified is treated as the 'usual' name.
+
+The chosen name will be selected according to the priority order of `preferredNames`,
+
+**`example`**
+// normal use case; prefer usual name, fallback to official name
+displayNameByUsage(patient, 'usual', 'official')
+
+**`example`**
+// prefer usual name over nickname, fallback to official name
+displayNameByUsage(patient, 'usual', 'nickname', 'official')
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `patient` | `Patient` | The patient from whom a name will be selected. |
+| `...preferredNames` | [`NameUse`](API.md#nameuse)[] | Optional ordered sequence of preferred name usages; defaults to 'usual' if not specified. |
+
+#### Returns
+
+`fhir.HumanName` \| `undefined`
+
+the preferred name for the patient, or undefined if no acceptable name could be found.
+
+#### Defined in
+
+[packages/framework/esm-utils/src/patient-helpers.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/patient-helpers.ts#L47)
+
+___
+
 ### shallowEqual
 
 ▸ **shallowEqual**(`a`, `b`): `boolean`

package/docs/interfaces/AuditInfo.md

@@ -0,0 +1,140 @@
+[@openmrs/esm-framework](../API.md) / AuditInfo
+
+# Interface: AuditInfo
+
+## Table of contents
+
+### Properties
+
+- [changedBy](AuditInfo.md#changedby)
+- [creator](AuditInfo.md#creator)
+- [dateChanged](AuditInfo.md#datechanged)
+- [dateCreated](AuditInfo.md#datecreated)
+- [dateVoided](AuditInfo.md#datevoided)
+- [datedRetired](AuditInfo.md#datedretired)
+- [retireReason](AuditInfo.md#retirereason)
+- [retired](AuditInfo.md#retired)
+- [retiredBy](AuditInfo.md#retiredby)
+- [voidReason](AuditInfo.md#voidreason)
+- [voided](AuditInfo.md#voided)
+- [voidedBy](AuditInfo.md#voidedby)
+
+## Properties
+
+### changedBy
+
+• `Optional` **changedBy**: [`User`](User.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L30)
+
+___
+
+### creator
+
+• `Optional` **creator**: [`User`](User.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L28)
+
+___
+
+### dateChanged
+
+• `Optional` **dateChanged**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L29)
+
+___
+
+### dateCreated
+
+• `Optional` **dateCreated**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L27)
+
+___
+
+### dateVoided
+
+• `Optional` **dateVoided**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L32)
+
+___
+
+### datedRetired
+
+• `Optional` **datedRetired**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L36)
+
+___
+
+### retireReason
+
+• `Optional` **retireReason**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L38)
+
+___
+
+### retired
+
+• `Optional` **retired**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L35)
+
+___
+
+### retiredBy
+
+• `Optional` **retiredBy**: [`User`](User.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L37)
+
+___
+
+### voidReason
+
+• `Optional` **voidReason**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L34)
+
+___
+
+### voided
+
+• `Optional` **voided**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L31)
+
+___
+
+### voidedBy
+
+• `Optional` **voidedBy**: [`User`](User.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L33)

package/docs/interfaces/Concept.md

@@ -0,0 +1,89 @@
+[@openmrs/esm-framework](../API.md) / Concept
+
+# Interface: Concept
+
+## Hierarchy
+
+- [`OpenmrsResource`](OpenmrsResource.md)
+
+  ↳ **`Concept`**
+
+## Table of contents
+
+### Properties
+
+- [auditInfo](Concept.md#auditinfo)
+- [display](Concept.md#display)
+- [links](Concept.md#links)
+- [resourceVersion](Concept.md#resourceversion)
+- [uuid](Concept.md#uuid)
+
+## Properties
+
+### auditInfo
+
+• `Optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
+
+#### Inherited from
+
+[OpenmrsResource](OpenmrsResource.md).[auditInfo](OpenmrsResource.md#auditinfo)
+
+#### 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)
+
+___
+
+### display
+
+• `Optional` **display**: `string`
+
+#### Inherited from
+
+[OpenmrsResource](OpenmrsResource.md).[display](OpenmrsResource.md#display)
+
+#### 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)
+
+___
+
+### links
+
+• `Optional` **links**: [`Link`](Link.md)[]
+
+#### Inherited from
+
+[OpenmrsResource](OpenmrsResource.md).[links](OpenmrsResource.md#links)
+
+#### 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)
+
+___
+
+### resourceVersion
+
+• `Optional` **resourceVersion**: `string`
+
+#### Inherited from
+
+[OpenmrsResource](OpenmrsResource.md).[resourceVersion](OpenmrsResource.md#resourceversion)
+
+#### 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)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Inherited from
+
+[OpenmrsResource](OpenmrsResource.md).[uuid](OpenmrsResource.md#uuid)
+
+#### 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)

package/docs/interfaces/Link.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / Link
+
+# Interface: Link
+
+## Table of contents
+
+### Properties
+
+- [rel](Link.md#rel)
+- [resourceAlias](Link.md#resourcealias)
+- [uri](Link.md#uri)
+
+## Properties
+
+### rel
+
+• **rel**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L21)
+
+___
+
+### resourceAlias
+
+• `Optional` **resourceAlias**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L23)
+
+___
+
+### uri
+
+• **uri**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L22)